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(SelectObjectContentEndpointParamsInterceptor)
121                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::select_object_content::SelectObjectContentError>::new())
122.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::select_object_content::SelectObjectContentError>::new())
123.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::select_object_content::SelectObjectContentError>::builder().transient_errors({
124                                            let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
125                                            transient_errors.push("InternalError");
126                                            ::std::borrow::Cow::Owned(transient_errors)
127                                            }).build());
128
129        ::std::borrow::Cow::Owned(rcb)
130    }
131}
132
133#[derive(Debug)]
134struct SelectObjectContentResponseDeserializer;
135impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for SelectObjectContentResponseDeserializer {
136    fn deserialize_streaming(
137        &self,
138        response: &mut ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
139    ) -> ::std::option::Option<::aws_smithy_runtime_api::client::interceptors::context::OutputOrError> {
140        #[allow(unused_mut)]
141        let mut force_error = false;
142        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
143        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
144
145        // If this is an error, defer to the non-streaming parser
146        if (!response.status().is_success() && response.status().as_u16() != 200) || force_error {
147            return ::std::option::Option::None;
148        }
149        ::std::option::Option::Some(crate::protocol_serde::type_erase_result(
150            crate::protocol_serde::shape_select_object_content::de_select_object_content_http_response(response),
151        ))
152    }
153
154    fn deserialize_nonstreaming(
155        &self,
156        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
157    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
158        // For streaming operations, we only hit this case if its an error
159        let body = response.body().bytes().expect("body loaded");
160        crate::protocol_serde::type_erase_result(crate::protocol_serde::shape_select_object_content::de_select_object_content_http_error(
161            response.status().as_u16(),
162            response.headers(),
163            body,
164        ))
165    }
166}
167#[derive(Debug)]
168struct SelectObjectContentRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for SelectObjectContentRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::select_object_content::SelectObjectContentInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            fn uri_base(
185                _input: &crate::operation::select_object_content::SelectObjectContentInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.key;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
193                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
194                if key.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "key",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
201                ::std::result::Result::Ok(())
202            }
203            fn uri_query(
204                _input: &crate::operation::select_object_content::SelectObjectContentInput,
205                mut output: &mut ::std::string::String,
206            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
207                let mut query = ::aws_smithy_http::query::Writer::new(output);
208                query.push_v("select");
209                query.push_kv("select-type", "2");
210                ::std::result::Result::Ok(())
211            }
212            #[allow(clippy::unnecessary_wraps)]
213            fn update_http_builder(
214                input: &crate::operation::select_object_content::SelectObjectContentInput,
215                builder: ::http::request::Builder,
216            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
217                let mut uri = ::std::string::String::new();
218                uri_base(input, &mut uri)?;
219                uri_query(input, &mut uri)?;
220                let builder = crate::protocol_serde::shape_select_object_content::ser_select_object_content_headers(input, builder)?;
221                ::std::result::Result::Ok(builder.method("POST").uri(uri))
222            }
223            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
224            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
225            builder
226        };
227        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_select_object_content::ser_select_object_content_op_input(
228            &input,
229        )?);
230        if let Some(content_length) = body.content_length() {
231            let content_length = content_length.to_string();
232            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
233        }
234        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
235    }
236}
237#[derive(Debug)]
238struct SelectObjectContentEndpointParamsInterceptor;
239
240impl ::aws_smithy_runtime_api::client::interceptors::Intercept for SelectObjectContentEndpointParamsInterceptor {
241    fn name(&self) -> &'static str {
242        "SelectObjectContentEndpointParamsInterceptor"
243    }
244
245    fn read_before_execution(
246        &self,
247        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
248            '_,
249            ::aws_smithy_runtime_api::client::interceptors::context::Input,
250            ::aws_smithy_runtime_api::client::interceptors::context::Output,
251            ::aws_smithy_runtime_api::client::interceptors::context::Error,
252        >,
253        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
254    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
255        let _input = context
256            .input()
257            .downcast_ref::<SelectObjectContentInput>()
258            .ok_or("failed to downcast to SelectObjectContentInput")?;
259
260        let params = crate::config::endpoint::Params::builder()
261            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
262            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
263            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
264            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
265            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
266            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
267            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
268            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
269            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
270            .set_bucket(Some(
271                _input
272                    .bucket
273                    .clone()
274                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
275                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
276            ))
277            .build()
278            .map_err(|err| {
279                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
280            })?;
281        cfg.interceptor_state()
282            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
283        ::std::result::Result::Ok(())
284    }
285}
286
287// The get_* functions below are generated from JMESPath expressions in the
288// operationContextParams trait. They target the operation's input shape.
289
290/// Error type for the `SelectObjectContentError` operation.
291#[non_exhaustive]
292#[derive(::std::fmt::Debug)]
293pub enum SelectObjectContentError {
294    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
295    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
296    variable wildcard pattern and check `.code()`:
297     \
298    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
299     \
300    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-SelectObjectContentError) for what information is available for the error.")]
301    Unhandled(crate::error::sealed_unhandled::Unhandled),
302}
303impl SelectObjectContentError {
304    /// Creates the `SelectObjectContentError::Unhandled` variant from any error type.
305    pub fn unhandled(
306        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
307    ) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.into(),
310            meta: ::std::default::Default::default(),
311        })
312    }
313
314    /// Creates the `SelectObjectContentError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
315    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
316        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
317            source: err.clone().into(),
318            meta: err,
319        })
320    }
321    ///
322    /// Returns error metadata, which includes the error code, message,
323    /// request ID, and potentially additional information.
324    ///
325    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
326        match self {
327            Self::Unhandled(e) => &e.meta,
328        }
329    }
330}
331impl ::std::error::Error for SelectObjectContentError {
332    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
333        match self {
334            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
335        }
336    }
337}
338impl ::std::fmt::Display for SelectObjectContentError {
339    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
340        match self {
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 SelectObjectContentError {
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 SelectObjectContentError {
360    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
361        match self {
362            Self::Unhandled(_inner) => &_inner.meta,
363        }
364    }
365}
366impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for SelectObjectContentError {
367    fn create_unhandled_error(
368        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
369        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
370    ) -> Self {
371        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
372            source,
373            meta: meta.unwrap_or_default(),
374        })
375    }
376}
377impl crate::s3_request_id::RequestIdExt for crate::operation::select_object_content::SelectObjectContentError {
378    fn extended_request_id(&self) -> Option<&str> {
379        self.meta().extended_request_id()
380    }
381}
382impl ::aws_types::request_id::RequestId for crate::operation::select_object_content::SelectObjectContentError {
383    fn request_id(&self) -> Option<&str> {
384        self.meta().request_id()
385    }
386}
387
388pub use crate::operation::select_object_content::_select_object_content_output::SelectObjectContentOutput;
389
390pub use crate::operation::select_object_content::_select_object_content_input::SelectObjectContentInput;
391
392mod _select_object_content_input;
393
394mod _select_object_content_output;
395
396/// Builders
397pub mod builders;