Skip to main content

aws_sdk_dynamodb/operation/
describe_export.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeExport`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeExport;
6impl DescribeExport {
7    /// Creates a new `DescribeExport`
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_export::DescribeExportInput,
14                    ) -> ::std::result::Result<crate::operation::describe_export::DescribeExportOutput, ::aws_smithy_runtime_api::client::result::SdkError<crate::operation::describe_export::DescribeExportError, ::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_export::DescribeExportError>().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_export::DescribeExportOutput>().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_export::DescribeExportInput,
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                            "DescribeExport",
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.DescribeExport",
45                                "rpc.service" = "DynamoDB",
46                                "rpc.method" = "DescribeExport",
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 DescribeExport {
72                fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
73                    let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeExport");
74
75                    cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(DescribeExportRequestSerializer));
76                    cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(DescribeExportResponseDeserializer));
77
78                    cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
79                        crate::config::auth::Params::builder()
80                            .operation_name("DescribeExport")
81                            .build()
82                            .expect("required fields set")
83                    ));
84
85                    cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
86                            "DescribeExport",
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("DescribeExport")
106                            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(DescribeExportTelemetryInputCaptureInterceptor))
107.with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default()))
108.with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(DescribeExportEndpointParamsInterceptor))
109                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::describe_export::DescribeExportError>::new())
110.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::describe_export::DescribeExportError>::new())
111.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::describe_export::DescribeExportError>::new());
112
113                    ::std::borrow::Cow::Owned(rcb)
114                }
115            }
116
117            #[derive(Debug)]
118            struct DescribeExportTelemetryInputCaptureInterceptor;
119
120            #[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
121            impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeExportTelemetryInputCaptureInterceptor {
122                fn name(&self) -> &'static str {
123                    "DescribeExportTelemetryInputCaptureInterceptor"
124                }
125
126                fn read_before_execution(
127                    &self,
128                    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>,
129                    cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
130                ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
131                    // Nothing to do unless the customer opted in by naming members to record.
132                    let ::std::option::Option::Some(requested) = cfg.load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>().filter(|r| !r.is_empty()) else {
133                        return ::std::result::Result::Ok(());
134                    };
135
136                    let ::std::option::Option::Some(input) = context.input().downcast_ref::<DescribeExportInput>() else {
137                        // A mismatched input is not this interceptor's concern; skip quietly.
138                        return ::std::result::Result::Ok(());
139                    };
140
141                    let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
142                    if requested.should_capture("ExportArn") {
143                        if let ::std::option::Option::Some(value) = input.export_arn.as_deref() {
144                            captured.insert("ExportArn", value);
145                        }
146                    }
147
148                    cfg.interceptor_state().store_put(captured);
149                    ::std::result::Result::Ok(())
150                }
151            }
152#[derive(Debug)]
153            struct DescribeExportResponseDeserializer;
154            impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeExportResponseDeserializer {
155
156
157                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 {
158                    let (success, status) = (response.status().is_success(), response.status().as_u16());
159            let headers = response.headers();
160            let body = response.body().bytes().expect("body loaded");
161            #[allow(unused_mut)]
162            let mut force_error = false;
163            ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
164            let parse_result = if !success && status != 200 || force_error {
165                crate::protocol_serde::shape_describe_export::de_describe_export_http_error(status, headers, body)
166            } else {
167                crate::protocol_serde::shape_describe_export::de_describe_export_http_response(status, headers, body)
168            };
169            crate::protocol_serde::type_erase_result(parse_result)
170                }
171            }
172#[derive(Debug)]
173            struct DescribeExportRequestSerializer;
174            impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeExportRequestSerializer {
175                #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
176                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> {
177                    let input = input.downcast::<crate::operation::describe_export::DescribeExportInput>().expect("correct type");
178                    let _header_serialization_settings = _cfg.load::<crate::serialization_settings::HeaderSerializationSettings>().cloned().unwrap_or_default();
179                    let mut request_builder = {
180                        #[allow(clippy::uninlined_format_args)]
181fn uri_base(_input: &crate::operation::describe_export::DescribeExportInput, output: &mut ::std::string::String) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182    use ::std::fmt::Write as _;
183    ::std::write!(output, "/").expect("formatting should succeed");
184    ::std::result::Result::Ok(())
185}
186#[allow(clippy::unnecessary_wraps)]
187fn update_http_builder(
188                input: &crate::operation::describe_export::DescribeExportInput,
189                builder: ::http_1x::request::Builder
190            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
191    let mut uri = ::std::string::String::new();
192    uri_base(input, &mut uri)?;
193    ::std::result::Result::Ok(builder.method("POST").uri(uri))
194}
195let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
196builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.0");
197builder = _header_serialization_settings.set_default_header(
198                        builder,
199                        ::http_1x::header::HeaderName::from_static("x-amz-target"),
200                        "DynamoDB_20120810.DescribeExport"
201                    );
202builder
203                    };
204                    let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_export::ser_describe_export_input(&input)?);
205                    if let Some(content_length) = body.content_length() {
206                                let content_length = content_length.to_string();
207                                request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
208                            }
209                    ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
210                }
211            }
212#[derive(Debug)]
213            struct DescribeExportEndpointParamsInterceptor;
214
215            #[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
216            impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeExportEndpointParamsInterceptor {
217                fn name(&self) -> &'static str {
218                    "DescribeExportEndpointParamsInterceptor"
219                }
220
221                fn read_before_execution(
222                    &self,
223                    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>,
224                    cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
225                ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
226                    let _input = context.input()
227                        .downcast_ref::<DescribeExportInput>()
228                        .ok_or("failed to downcast to DescribeExportInput")?;
229
230
231
232                    let params = crate::config::endpoint::Params::builder()
233                        .set_region(cfg.load::<::aws_types::region::Region>().map(|r|r.as_ref().to_owned()))
234.set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
235.set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
236.set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
237.set_account_id_endpoint_mode(::std::option::Option::Some(cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>().cloned().unwrap_or_default().to_string()))
238.set_resource_arn(Some(_input.export_arn.clone().filter(|f|!AsRef::<str>::as_ref(f).trim().is_empty()).ok_or_else(||::aws_smithy_types::error::operation::BuildError::missing_field("export_arn", "A required field was not set"))?))
239                        .build()
240                        .map_err(|err| ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err))?;
241                    cfg.interceptor_state().store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
242                    ::std::result::Result::Ok(())
243                }
244            }
245
246            // The get_* functions below are generated from JMESPath expressions in the
247            // operationContextParams trait. They target the operation's input shape.
248
249
250
251/// Error type for the `DescribeExportError` operation.
252#[non_exhaustive]
253#[derive(::std::fmt::Debug)]
254pub enum DescribeExportError {
255    /// <p>The specified export was not found.</p>
256    ExportNotFoundException(crate::types::error::ExportNotFoundException),
257    /// <p>An error occurred on the server side.</p>
258    InternalServerError(crate::types::error::InternalServerError),
259    /// <p>There is no limit to the number of daily on-demand backups that can be taken.</p>
260    /// <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>.</p>
261    /// <p>When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.</p>
262    /// <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
263    /// <p>There is a soft account quota of 2,500 tables.</p>
264    /// <p>GetRecords was called with a value of more than 1000 for the limit request parameter.</p>
265    /// <p>More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.</p>
266    LimitExceededException(crate::types::error::LimitExceededException),
267    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
268                    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
269    variable wildcard pattern and check `.code()`:
270     \
271    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
272     \
273    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeExportError) for what information is available for the error.")]
274                    Unhandled(crate::error::sealed_unhandled::Unhandled),
275}
276impl DescribeExportError {
277    /// Creates the `DescribeExportError::Unhandled` variant from any error type.
278                    pub fn unhandled(err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>) -> Self {
279                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.into(), meta: ::std::default::Default::default() })
280                    }
281
282                    /// Creates the `DescribeExportError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
283                    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
284                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.clone().into(), meta: err })
285                    }
286    ///
287    /// Returns error metadata, which includes the error code, message,
288    /// request ID, and potentially additional information.
289    ///
290    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
291        match self {
292            Self::ExportNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
293            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
294            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
295            Self::Unhandled(e) => &e.meta,
296        }
297    }
298    /// Returns `true` if the error kind is `DescribeExportError::ExportNotFoundException`.
299    pub fn is_export_not_found_exception(&self) -> bool {
300        matches!(self, Self::ExportNotFoundException(_))
301    }
302    /// Returns `true` if the error kind is `DescribeExportError::InternalServerError`.
303    pub fn is_internal_server_error(&self) -> bool {
304        matches!(self, Self::InternalServerError(_))
305    }
306    /// Returns `true` if the error kind is `DescribeExportError::LimitExceededException`.
307    pub fn is_limit_exceeded_exception(&self) -> bool {
308        matches!(self, Self::LimitExceededException(_))
309    }
310}
311impl ::std::error::Error for DescribeExportError {
312    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
313        match self {
314            Self::ExportNotFoundException(_inner) =>
315            ::std::option::Option::Some(_inner)
316            ,
317            Self::InternalServerError(_inner) =>
318            ::std::option::Option::Some(_inner)
319            ,
320            Self::LimitExceededException(_inner) =>
321            ::std::option::Option::Some(_inner)
322            ,
323            Self::Unhandled(_inner) => {
324                ::std::option::Option::Some(&*_inner.source)
325            }
326        }
327    }
328}
329impl ::std::fmt::Display for DescribeExportError {
330    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
331        match self {
332            Self::ExportNotFoundException(_inner) =>
333            _inner.fmt(f)
334            ,
335            Self::InternalServerError(_inner) =>
336            _inner.fmt(f)
337            ,
338            Self::LimitExceededException(_inner) =>
339            _inner.fmt(f)
340            ,
341            Self::Unhandled(_inner) => {
342                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
343                                                        write!(f, "unhandled error ({code})")
344                                                    } else {
345                                                        f.write_str("unhandled error")
346                                                    }
347            }
348        }
349    }
350}
351impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeExportError {
352    fn code(&self) -> ::std::option::Option<&str> {
353        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
354    }
355    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
356        ::std::option::Option::None
357    }
358}
359impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeExportError {
360    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
361        match self {
362            Self::ExportNotFoundException(_inner) =>
363            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
364            ,
365            Self::InternalServerError(_inner) =>
366            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
367            ,
368            Self::LimitExceededException(_inner) =>
369            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
370            ,
371            Self::Unhandled(_inner) => {
372                &_inner.meta
373            }
374        }
375    }
376}
377impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeExportError {
378    fn create_unhandled_error(
379                        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
380                        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>
381                    ) -> Self {
382        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source, meta: meta.unwrap_or_default() })
383    }
384}
385impl ::aws_types::request_id::RequestId for crate::operation::describe_export::DescribeExportError {
386                                fn request_id(&self) -> Option<&str> {
387                                    self.meta().request_id()
388                                }
389                            }
390
391pub use crate::operation::describe_export::_describe_export_input::DescribeExportInput;
392
393pub use crate::operation::describe_export::_describe_export_output::DescribeExportOutput;
394
395mod _describe_export_input;
396
397mod _describe_export_output;
398
399/// Builders
400pub mod builders;
401