// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// Orchestration and serialization glue logic for `Scan`.
#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct Scan;
impl Scan {
/// Creates a new `Scan`
pub fn new() -> Self {
Self
}
pub(crate) async fn orchestrate(
runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
input: crate::operation::scan::ScanInput,
) -> ::std::result::Result<
crate::operation::scan::ScanOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::scan::ScanError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
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,
>| { err.map_service_error(|err| err.downcast::<crate::operation::scan::ScanError>().expect("correct error type")) };
let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
.await
.map_err(map_err)?;
let output = context.finalize().map_err(map_err)?;
::std::result::Result::Ok(output.downcast::<crate::operation::scan::ScanOutput>().expect("correct output type"))
}
pub(crate) async fn orchestrate_with_stop_point(
runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
input: crate::operation::scan::ScanInput,
stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
) -> ::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,
>,
> {
let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
use ::tracing::Instrument;
::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("DynamoDB", "Scan", input, runtime_plugins, stop_point)
// Create a parent span for the entire operation. Includes a random, internal-only,
// seven-digit ID for the operation orchestration so that it can be correlated in the logs.
.instrument(::tracing::debug_span!(
"DynamoDB.Scan",
"rpc.service" = "DynamoDB",
"rpc.method" = "Scan",
"sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
"rpc.system" = "aws-api",
))
.await
}
pub(crate) fn operation_runtime_plugins(
client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
client_config: &crate::config::Config,
config_override: ::std::option::Option<crate::config::Builder>,
) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
if let ::std::option::Option::Some(config_override) = config_override {
for plugin in config_override.runtime_plugins.iter().cloned() {
runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
}
runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
config_override,
client_config.config.clone(),
&client_config.runtime_components,
));
}
runtime_plugins
}
}
impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for Scan {
fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
let mut cfg = ::aws_smithy_types::config_bag::Layer::new("Scan");
cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
ScanRequestSerializer,
));
cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
ScanResponseDeserializer,
));
cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
crate::config::auth::Params::builder()
.operation_name("Scan")
.build()
.expect("required fields set"),
));
cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("Scan", "DynamoDB"));
let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
signing_options.double_uri_encode = true;
signing_options.content_sha256_header = false;
signing_options.normalize_uri_path = true;
signing_options.payload_override = None;
cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
signing_options,
..::std::default::Default::default()
});
::std::option::Option::Some(cfg.freeze())
}
fn runtime_components(
&self,
_: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
#[allow(unused_mut)]
let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("Scan")
.with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
.with_interceptor(ScanEndpointParamsInterceptor)
.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
crate::operation::scan::ScanError,
>::new())
.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
crate::operation::scan::ScanError,
>::new())
.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
crate::operation::scan::ScanError,
>::new());
::std::borrow::Cow::Owned(rcb)
}
}
#[derive(Debug)]
struct ScanResponseDeserializer;
impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ScanResponseDeserializer {
fn deserialize_nonstreaming(
&self,
response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
let (success, status) = (response.status().is_success(), response.status().as_u16());
let headers = response.headers();
let body = response.body().bytes().expect("body loaded");
#[allow(unused_mut)]
let mut force_error = false;
::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
let parse_result = if !success && status != 200 || force_error {
crate::protocol_serde::shape_scan::de_scan_http_error(status, headers, body)
} else {
crate::protocol_serde::shape_scan::de_scan_http_response(status, headers, body)
};
crate::protocol_serde::type_erase_result(parse_result)
}
}
#[derive(Debug)]
struct ScanRequestSerializer;
impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ScanRequestSerializer {
#[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
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> {
let input = input.downcast::<crate::operation::scan::ScanInput>().expect("correct type");
let _header_serialization_settings = _cfg
.load::<crate::serialization_settings::HeaderSerializationSettings>()
.cloned()
.unwrap_or_default();
let mut request_builder = {
#[allow(clippy::uninlined_format_args)]
fn uri_base(
_input: &crate::operation::scan::ScanInput,
output: &mut ::std::string::String,
) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
use ::std::fmt::Write as _;
::std::write!(output, "/").expect("formatting should succeed");
::std::result::Result::Ok(())
}
#[allow(clippy::unnecessary_wraps)]
fn update_http_builder(
input: &crate::operation::scan::ScanInput,
builder: ::http_1x::request::Builder,
) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
let mut uri = ::std::string::String::new();
uri_base(input, &mut uri)?;
::std::result::Result::Ok(builder.method("POST").uri(uri))
}
let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.0");
builder = _header_serialization_settings.set_default_header(
builder,
::http_1x::header::HeaderName::from_static("x-amz-target"),
"DynamoDB_20120810.Scan",
);
builder
};
let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_scan::ser_scan_input(&input)?);
if let Some(content_length) = body.content_length() {
let content_length = content_length.to_string();
request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
}
::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
}
}
#[derive(Debug)]
struct ScanEndpointParamsInterceptor;
impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ScanEndpointParamsInterceptor {
fn name(&self) -> &'static str {
"ScanEndpointParamsInterceptor"
}
fn read_before_execution(
&self,
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,
>,
cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
let _input = context.input().downcast_ref::<ScanInput>().ok_or("failed to downcast to ScanInput")?;
let params = crate::config::endpoint::Params::builder()
.set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
.set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
.set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
.set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
.set_account_id_endpoint_mode(::std::option::Option::Some(
cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>()
.cloned()
.unwrap_or_default()
.to_string(),
))
.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"))?,
))
.build()
.map_err(|err| {
::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
})?;
cfg.interceptor_state()
.store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
::std::result::Result::Ok(())
}
}
// The get_* functions below are generated from JMESPath expressions in the
// operationContextParams trait. They target the operation's input shape.
/// Error type for the `ScanError` operation.
#[non_exhaustive]
#[derive(::std::fmt::Debug)]
pub enum ScanError {
/// <p>An error occurred on the server side.</p>
InternalServerError(crate::types::error::InternalServerError),
#[allow(missing_docs)] // documentation missing in model
InvalidEndpointException(crate::types::error::InvalidEndpointException),
/// <p>The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
/// <p>Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. Contact <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a quota increase.</p>
RequestLimitExceeded(crate::types::error::RequestLimitExceeded),
/// <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>
ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
/// <p>The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception.</p>
ThrottlingException(crate::types::error::ThrottlingException),
/// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
#[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
variable wildcard pattern and check `.code()`:
\
`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
\
See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ScanError) for what information is available for the error.")]
Unhandled(crate::error::sealed_unhandled::Unhandled),
}
impl ScanError {
/// Creates the `ScanError::Unhandled` variant from any error type.
pub fn unhandled(
err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
) -> Self {
Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
source: err.into(),
meta: ::std::default::Default::default(),
})
}
/// Creates the `ScanError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
source: err.clone().into(),
meta: err,
})
}
///
/// Returns error metadata, which includes the error code, message,
/// request ID, and potentially additional information.
///
pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
match self {
Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
Self::RequestLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
Self::Unhandled(e) => &e.meta,
}
}
/// Returns `true` if the error kind is `ScanError::InternalServerError`.
pub fn is_internal_server_error(&self) -> bool {
matches!(self, Self::InternalServerError(_))
}
/// Returns `true` if the error kind is `ScanError::InvalidEndpointException`.
pub fn is_invalid_endpoint_exception(&self) -> bool {
matches!(self, Self::InvalidEndpointException(_))
}
/// Returns `true` if the error kind is `ScanError::ProvisionedThroughputExceededException`.
pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
matches!(self, Self::ProvisionedThroughputExceededException(_))
}
/// Returns `true` if the error kind is `ScanError::RequestLimitExceeded`.
pub fn is_request_limit_exceeded(&self) -> bool {
matches!(self, Self::RequestLimitExceeded(_))
}
/// Returns `true` if the error kind is `ScanError::ResourceNotFoundException`.
pub fn is_resource_not_found_exception(&self) -> bool {
matches!(self, Self::ResourceNotFoundException(_))
}
/// Returns `true` if the error kind is `ScanError::ThrottlingException`.
pub fn is_throttling_exception(&self) -> bool {
matches!(self, Self::ThrottlingException(_))
}
}
impl ::std::error::Error for ScanError {
fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
match self {
Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
Self::InvalidEndpointException(_inner) => ::std::option::Option::Some(_inner),
Self::ProvisionedThroughputExceededException(_inner) => ::std::option::Option::Some(_inner),
Self::RequestLimitExceeded(_inner) => ::std::option::Option::Some(_inner),
Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
}
}
}
impl ::std::fmt::Display for ScanError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match self {
Self::InternalServerError(_inner) => _inner.fmt(f),
Self::InvalidEndpointException(_inner) => _inner.fmt(f),
Self::ProvisionedThroughputExceededException(_inner) => _inner.fmt(f),
Self::RequestLimitExceeded(_inner) => _inner.fmt(f),
Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
Self::ThrottlingException(_inner) => _inner.fmt(f),
Self::Unhandled(_inner) => {
if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
write!(f, "unhandled error ({code})")
} else {
f.write_str("unhandled error")
}
}
}
}
}
impl ::aws_smithy_types::retry::ProvideErrorKind for ScanError {
fn code(&self) -> ::std::option::Option<&str> {
::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
}
fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
::std::option::Option::None
}
}
impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ScanError {
fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
match self {
Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
Self::InvalidEndpointException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
Self::ProvisionedThroughputExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
Self::RequestLimitExceeded(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
Self::Unhandled(_inner) => &_inner.meta,
}
}
}
impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ScanError {
fn create_unhandled_error(
source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
) -> Self {
Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
source,
meta: meta.unwrap_or_default(),
})
}
}
impl ::aws_types::request_id::RequestId for crate::operation::scan::ScanError {
fn request_id(&self) -> Option<&str> {
self.meta().request_id()
}
}
pub use crate::operation::scan::_scan_input::ScanInput;
pub use crate::operation::scan::_scan_output::ScanOutput;
mod _scan_input;
mod _scan_output;
/// Builders
pub mod builders;
/// Paginator for this operation
pub mod paginator;