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