aws_sdk_s3/operation/
select_object_content.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `SelectObjectContent`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct SelectObjectContent;
6impl SelectObjectContent {
7    /// Creates a new `SelectObjectContent`
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::select_object_content::SelectObjectContentInput,
14    ) -> ::std::result::Result<
15        crate::operation::select_object_content::SelectObjectContentOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::select_object_content::SelectObjectContentError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::select_object_content::SelectObjectContentError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::select_object_content::SelectObjectContentOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::select_object_content::SelectObjectContentInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "SelectObjectContent", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64            #[cfg(feature = "sigv4a")]
65            {
66                ::aws_runtime::auth::sigv4a::SCHEME_ID
67            },
68            crate::s3_express::auth::SCHEME_ID,
69            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
70        ]));
71        if let ::std::option::Option::Some(config_override) = config_override {
72            for plugin in config_override.runtime_plugins.iter().cloned() {
73                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
74            }
75            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
76                config_override,
77                client_config.config.clone(),
78                &client_config.runtime_components,
79            ));
80        }
81        runtime_plugins
82    }
83}
84impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for SelectObjectContent {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("SelectObjectContent");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            SelectObjectContentRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            SelectObjectContentResponseDeserializer,
93        ));
94
95        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
96            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("SelectObjectContent", "s3"));
100        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
101        signing_options.double_uri_encode = false;
102        signing_options.content_sha256_header = true;
103        signing_options.normalize_uri_path = false;
104        signing_options.payload_override = None;
105
106        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
107            signing_options,
108            ..::std::default::Default::default()
109        });
110
111        ::std::option::Option::Some(cfg.freeze())
112    }
113
114    fn runtime_components(
115        &self,
116        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
117    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
118        #[allow(unused_mut)]
119        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("SelectObjectContent")
120            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
121            .with_interceptor(SelectObjectContentEndpointParamsInterceptor)
122            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
123                crate::operation::select_object_content::SelectObjectContentError,
124            >::new())
125            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
126                crate::operation::select_object_content::SelectObjectContentError,
127            >::new())
128            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
129                crate::operation::select_object_content::SelectObjectContentError,
130            >::new());
131
132        ::std::borrow::Cow::Owned(rcb)
133    }
134}
135
136#[derive(Debug)]
137struct SelectObjectContentResponseDeserializer;
138impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for SelectObjectContentResponseDeserializer {
139    fn deserialize_streaming(
140        &self,
141        response: &mut ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
142    ) -> ::std::option::Option<::aws_smithy_runtime_api::client::interceptors::context::OutputOrError> {
143        #[allow(unused_mut)]
144        let mut force_error = false;
145        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
146        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
147
148        // If this is an error, defer to the non-streaming parser
149        if (!response.status().is_success() && response.status().as_u16() != 200) || force_error {
150            return ::std::option::Option::None;
151        }
152        ::std::option::Option::Some(crate::protocol_serde::type_erase_result(
153            crate::protocol_serde::shape_select_object_content::de_select_object_content_http_response(response),
154        ))
155    }
156
157    fn deserialize_nonstreaming(
158        &self,
159        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
160    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
161        // For streaming operations, we only hit this case if its an error
162        let body = response.body().bytes().expect("body loaded");
163        crate::protocol_serde::type_erase_result(crate::protocol_serde::shape_select_object_content::de_select_object_content_http_error(
164            response.status().as_u16(),
165            response.headers(),
166            body,
167        ))
168    }
169}
170#[derive(Debug)]
171struct SelectObjectContentRequestSerializer;
172impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for SelectObjectContentRequestSerializer {
173    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
174    fn serialize_input(
175        &self,
176        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
177        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
178    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
179        let input = input
180            .downcast::<crate::operation::select_object_content::SelectObjectContentInput>()
181            .expect("correct type");
182        let _header_serialization_settings = _cfg
183            .load::<crate::serialization_settings::HeaderSerializationSettings>()
184            .cloned()
185            .unwrap_or_default();
186        let mut request_builder = {
187            fn uri_base(
188                _input: &crate::operation::select_object_content::SelectObjectContentInput,
189                output: &mut ::std::string::String,
190            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
191                use ::std::fmt::Write as _;
192                let input_1 = &_input.key;
193                let input_1 = input_1
194                    .as_ref()
195                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
196                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
197                if key.is_empty() {
198                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
199                        "key",
200                        "cannot be empty or unset",
201                    ));
202                }
203                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
204                ::std::result::Result::Ok(())
205            }
206            fn uri_query(
207                _input: &crate::operation::select_object_content::SelectObjectContentInput,
208                mut output: &mut ::std::string::String,
209            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
210                let mut query = ::aws_smithy_http::query::Writer::new(output);
211                query.push_v("select");
212                query.push_kv("select-type", "2");
213                query.push_kv("x-id", "SelectObjectContent");
214                ::std::result::Result::Ok(())
215            }
216            #[allow(clippy::unnecessary_wraps)]
217            fn update_http_builder(
218                input: &crate::operation::select_object_content::SelectObjectContentInput,
219                builder: ::http::request::Builder,
220            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
221                let mut uri = ::std::string::String::new();
222                uri_base(input, &mut uri)?;
223                uri_query(input, &mut uri)?;
224                let builder = crate::protocol_serde::shape_select_object_content::ser_select_object_content_headers(input, builder)?;
225                ::std::result::Result::Ok(builder.method("POST").uri(uri))
226            }
227            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
228            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
229            builder
230        };
231        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_select_object_content::ser_select_object_content_op_input(
232            &input,
233        )?);
234        if let Some(content_length) = body.content_length() {
235            let content_length = content_length.to_string();
236            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
237        }
238        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
239    }
240}
241#[derive(Debug)]
242struct SelectObjectContentEndpointParamsInterceptor;
243
244impl ::aws_smithy_runtime_api::client::interceptors::Intercept for SelectObjectContentEndpointParamsInterceptor {
245    fn name(&self) -> &'static str {
246        "SelectObjectContentEndpointParamsInterceptor"
247    }
248
249    fn read_before_execution(
250        &self,
251        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
252            '_,
253            ::aws_smithy_runtime_api::client::interceptors::context::Input,
254            ::aws_smithy_runtime_api::client::interceptors::context::Output,
255            ::aws_smithy_runtime_api::client::interceptors::context::Error,
256        >,
257        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
258    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
259        let _input = context
260            .input()
261            .downcast_ref::<SelectObjectContentInput>()
262            .ok_or("failed to downcast to SelectObjectContentInput")?;
263
264        let params = crate::config::endpoint::Params::builder()
265            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
266            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
267            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
268            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
269            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
270            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
271            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
272            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
273            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
274            .set_bucket(Some(
275                _input
276                    .bucket
277                    .clone()
278                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
279                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
280            ))
281            .build()
282            .map_err(|err| {
283                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
284            })?;
285        cfg.interceptor_state()
286            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
287        ::std::result::Result::Ok(())
288    }
289}
290
291/// Error type for the `SelectObjectContentError` operation.
292#[non_exhaustive]
293#[derive(::std::fmt::Debug)]
294pub enum SelectObjectContentError {
295    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
296    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
297    variable wildcard pattern and check `.code()`:
298     \
299    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
300     \
301    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-SelectObjectContentError) for what information is available for the error.")]
302    Unhandled(crate::error::sealed_unhandled::Unhandled),
303}
304impl SelectObjectContentError {
305    /// Creates the `SelectObjectContentError::Unhandled` variant from any error type.
306    pub fn unhandled(
307        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
308    ) -> Self {
309        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
310            source: err.into(),
311            meta: ::std::default::Default::default(),
312        })
313    }
314
315    /// Creates the `SelectObjectContentError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
316    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
317        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
318            source: err.clone().into(),
319            meta: err,
320        })
321    }
322    ///
323    /// Returns error metadata, which includes the error code, message,
324    /// request ID, and potentially additional information.
325    ///
326    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
327        match self {
328            Self::Unhandled(e) => &e.meta,
329        }
330    }
331}
332impl ::std::error::Error for SelectObjectContentError {
333    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
334        match self {
335            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
336        }
337    }
338}
339impl ::std::fmt::Display for SelectObjectContentError {
340    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
341        match self {
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 SelectObjectContentError {
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 SelectObjectContentError {
361    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
362        match self {
363            Self::Unhandled(_inner) => &_inner.meta,
364        }
365    }
366}
367impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for SelectObjectContentError {
368    fn create_unhandled_error(
369        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
370        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
371    ) -> Self {
372        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
373            source,
374            meta: meta.unwrap_or_default(),
375        })
376    }
377}
378impl crate::s3_request_id::RequestIdExt for crate::operation::select_object_content::SelectObjectContentError {
379    fn extended_request_id(&self) -> Option<&str> {
380        self.meta().extended_request_id()
381    }
382}
383impl ::aws_types::request_id::RequestId for crate::operation::select_object_content::SelectObjectContentError {
384    fn request_id(&self) -> Option<&str> {
385        self.meta().request_id()
386    }
387}
388
389pub use crate::operation::select_object_content::_select_object_content_output::SelectObjectContentOutput;
390
391pub use crate::operation::select_object_content::_select_object_content_input::SelectObjectContentInput;
392
393mod _select_object_content_input;
394
395mod _select_object_content_output;
396
397/// Builders
398pub mod builders;