aws_sdk_s3/operation/
list_object_annotations.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListObjectAnnotations`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListObjectAnnotations;
6impl ListObjectAnnotations {
7    /// Creates a new `ListObjectAnnotations`
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::list_object_annotations::ListObjectAnnotationsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_object_annotations::ListObjectAnnotationsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_object_annotations::ListObjectAnnotationsError,
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::list_object_annotations::ListObjectAnnotationsError>()
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::list_object_annotations::ListObjectAnnotationsOutput>()
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::list_object_annotations::ListObjectAnnotationsInput,
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", "ListObjectAnnotations", 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.ListObjectAnnotations",
59                "rpc.service" = "S3",
60                "rpc.method" = "ListObjectAnnotations",
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 ListObjectAnnotations {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListObjectAnnotations");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListObjectAnnotationsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListObjectAnnotationsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListObjectAnnotations")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ListObjectAnnotations",
107            "S3",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = false;
111        signing_options.content_sha256_header = true;
112        signing_options.normalize_uri_path = false;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb =
129            ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListObjectAnnotations")
130                .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
131                    ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
132                ))
133                .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
134                    ListObjectAnnotationsEndpointParamsInterceptor,
135                ))
136                .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
137                    crate::operation::list_object_annotations::ListObjectAnnotationsError,
138                >::new())
139                .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
140                    crate::operation::list_object_annotations::ListObjectAnnotationsError,
141                >::new())
142                .with_retry_classifier(
143                    ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
144                        crate::operation::list_object_annotations::ListObjectAnnotationsError,
145                    >::builder()
146                    .transient_errors({
147                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
148                        transient_errors.push("InternalError");
149                        ::std::borrow::Cow::Owned(transient_errors)
150                    })
151                    .build(),
152                );
153
154        ::std::borrow::Cow::Owned(rcb)
155    }
156}
157
158#[derive(Debug)]
159struct ListObjectAnnotationsResponseDeserializer;
160impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListObjectAnnotationsResponseDeserializer {
161    fn deserialize_nonstreaming_with_config(
162        &self,
163        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
164        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
165    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
166        let (success, status) = (response.status().is_success(), response.status().as_u16());
167        let headers = response.headers();
168        let body = response.body().bytes().expect("body loaded");
169        #[allow(unused_mut)]
170        let mut force_error = false;
171        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
172        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
173            force_error = true;
174        }
175        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
176        let parse_result = if !success && status != 200 || force_error {
177            crate::protocol_serde::shape_list_object_annotations::de_list_object_annotations_http_error(status, headers, body)
178        } else {
179            crate::protocol_serde::shape_list_object_annotations::de_list_object_annotations_http_response(status, headers, body)
180        };
181        crate::protocol_serde::type_erase_result(parse_result)
182    }
183}
184#[derive(Debug)]
185struct ListObjectAnnotationsRequestSerializer;
186impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListObjectAnnotationsRequestSerializer {
187    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
188    fn serialize_input(
189        &self,
190        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
191        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
192    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
193        let input = input
194            .downcast::<crate::operation::list_object_annotations::ListObjectAnnotationsInput>()
195            .expect("correct type");
196        let _header_serialization_settings = _cfg
197            .load::<crate::serialization_settings::HeaderSerializationSettings>()
198            .cloned()
199            .unwrap_or_default();
200        let mut request_builder = {
201            #[allow(clippy::uninlined_format_args)]
202            fn uri_base(
203                _input: &crate::operation::list_object_annotations::ListObjectAnnotationsInput,
204                output: &mut ::std::string::String,
205            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
206                use ::std::fmt::Write as _;
207                let input_1 = &_input.key;
208                let input_1 = input_1
209                    .as_ref()
210                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
211                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
212                if key.is_empty() {
213                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
214                        "key",
215                        "cannot be empty or unset",
216                    ));
217                }
218                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
219                ::std::result::Result::Ok(())
220            }
221            fn uri_query(
222                _input: &crate::operation::list_object_annotations::ListObjectAnnotationsInput,
223                mut output: &mut ::std::string::String,
224            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
225                let mut query = ::aws_smithy_http::query::Writer::new(output);
226                query.push_v("annotation");
227                query.push_kv("x-id", "ListObjectAnnotations");
228                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
229                    {
230                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
231                    }
232                }
233                if let ::std::option::Option::Some(inner_3) = &_input.max_annotation_results {
234                    {
235                        query.push_kv("max-annotation-results", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
236                    }
237                }
238                if let ::std::option::Option::Some(inner_4) = &_input.annotation_prefix {
239                    {
240                        query.push_kv("annotation-prefix", &::aws_smithy_http::query::fmt_string(inner_4));
241                    }
242                }
243                if let ::std::option::Option::Some(inner_5) = &_input.continuation_token {
244                    {
245                        query.push_kv("continuation-token", &::aws_smithy_http::query::fmt_string(inner_5));
246                    }
247                }
248                ::std::result::Result::Ok(())
249            }
250            #[allow(clippy::unnecessary_wraps)]
251            fn update_http_builder(
252                input: &crate::operation::list_object_annotations::ListObjectAnnotationsInput,
253                builder: ::http_1x::request::Builder,
254            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
255                let mut uri = ::std::string::String::new();
256                uri_base(input, &mut uri)?;
257                uri_query(input, &mut uri)?;
258                let builder = crate::protocol_serde::shape_list_object_annotations::ser_list_object_annotations_headers(input, builder)?;
259                ::std::result::Result::Ok(builder.method("GET").uri(uri))
260            }
261            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
262            builder
263        };
264        let body = ::aws_smithy_types::body::SdkBody::from("");
265
266        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
267    }
268}
269#[derive(Debug)]
270struct ListObjectAnnotationsEndpointParamsInterceptor;
271
272#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
273impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListObjectAnnotationsEndpointParamsInterceptor {
274    fn name(&self) -> &'static str {
275        "ListObjectAnnotationsEndpointParamsInterceptor"
276    }
277
278    fn read_before_execution(
279        &self,
280        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
281            '_,
282            ::aws_smithy_runtime_api::client::interceptors::context::Input,
283            ::aws_smithy_runtime_api::client::interceptors::context::Output,
284            ::aws_smithy_runtime_api::client::interceptors::context::Error,
285        >,
286        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
287    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
288        let _input = context
289            .input()
290            .downcast_ref::<ListObjectAnnotationsInput>()
291            .ok_or("failed to downcast to ListObjectAnnotationsInput")?;
292
293        let params = crate::config::endpoint::Params::builder()
294            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
295            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
296            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
297            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
298            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
299            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
300            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
301            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
302            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
303            .set_bucket(Some(
304                _input
305                    .bucket
306                    .clone()
307                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
308                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
309            ))
310            .build()
311            .map_err(|err| {
312                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
313            })?;
314        cfg.interceptor_state()
315            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
316        ::std::result::Result::Ok(())
317    }
318}
319
320// The get_* functions below are generated from JMESPath expressions in the
321// operationContextParams trait. They target the operation's input shape.
322
323/// Error type for the `ListObjectAnnotationsError` operation.
324#[non_exhaustive]
325#[derive(::std::fmt::Debug)]
326pub enum ListObjectAnnotationsError {
327    /// <p>The annotation prefix you provided is invalid.</p>
328    InvalidPrefix(crate::types::error::InvalidPrefix),
329    /// <p>The specified bucket does not exist.</p>
330    NoSuchBucket(crate::types::error::NoSuchBucket),
331    /// <p>The specified key does not exist.</p>
332    NoSuchKey(crate::types::error::NoSuchKey),
333    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
334    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
335    variable wildcard pattern and check `.code()`:
336     \
337    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
338     \
339    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListObjectAnnotationsError) for what information is available for the error.")]
340    Unhandled(crate::error::sealed_unhandled::Unhandled),
341}
342impl ListObjectAnnotationsError {
343    /// Creates the `ListObjectAnnotationsError::Unhandled` variant from any error type.
344    pub fn unhandled(
345        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
346    ) -> Self {
347        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
348            source: err.into(),
349            meta: ::std::default::Default::default(),
350        })
351    }
352
353    /// Creates the `ListObjectAnnotationsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
354    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
355        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
356            source: err.clone().into(),
357            meta: err,
358        })
359    }
360    ///
361    /// Returns error metadata, which includes the error code, message,
362    /// request ID, and potentially additional information.
363    ///
364    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
365        match self {
366            Self::InvalidPrefix(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
367            Self::NoSuchBucket(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
368            Self::NoSuchKey(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
369            Self::Unhandled(e) => &e.meta,
370        }
371    }
372    /// Returns `true` if the error kind is `ListObjectAnnotationsError::InvalidPrefix`.
373    pub fn is_invalid_prefix(&self) -> bool {
374        matches!(self, Self::InvalidPrefix(_))
375    }
376    /// Returns `true` if the error kind is `ListObjectAnnotationsError::NoSuchBucket`.
377    pub fn is_no_such_bucket(&self) -> bool {
378        matches!(self, Self::NoSuchBucket(_))
379    }
380    /// Returns `true` if the error kind is `ListObjectAnnotationsError::NoSuchKey`.
381    pub fn is_no_such_key(&self) -> bool {
382        matches!(self, Self::NoSuchKey(_))
383    }
384}
385impl ::std::error::Error for ListObjectAnnotationsError {
386    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
387        match self {
388            Self::InvalidPrefix(_inner) => ::std::option::Option::Some(_inner),
389            Self::NoSuchBucket(_inner) => ::std::option::Option::Some(_inner),
390            Self::NoSuchKey(_inner) => ::std::option::Option::Some(_inner),
391            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
392        }
393    }
394}
395impl ::std::fmt::Display for ListObjectAnnotationsError {
396    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
397        match self {
398            Self::InvalidPrefix(_inner) => _inner.fmt(f),
399            Self::NoSuchBucket(_inner) => _inner.fmt(f),
400            Self::NoSuchKey(_inner) => _inner.fmt(f),
401            Self::Unhandled(_inner) => {
402                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
403                    write!(f, "unhandled error ({code})")
404                } else {
405                    f.write_str("unhandled error")
406                }
407            }
408        }
409    }
410}
411impl ::aws_smithy_types::retry::ProvideErrorKind for ListObjectAnnotationsError {
412    fn code(&self) -> ::std::option::Option<&str> {
413        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
414    }
415    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
416        ::std::option::Option::None
417    }
418}
419impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListObjectAnnotationsError {
420    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
421        match self {
422            Self::InvalidPrefix(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
423            Self::NoSuchBucket(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
424            Self::NoSuchKey(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425            Self::Unhandled(_inner) => &_inner.meta,
426        }
427    }
428}
429impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListObjectAnnotationsError {
430    fn create_unhandled_error(
431        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
432        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
433    ) -> Self {
434        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
435            source,
436            meta: meta.unwrap_or_default(),
437        })
438    }
439}
440impl crate::s3_request_id::RequestIdExt for crate::operation::list_object_annotations::ListObjectAnnotationsError {
441    fn extended_request_id(&self) -> Option<&str> {
442        self.meta().extended_request_id()
443    }
444}
445impl ::aws_types::request_id::RequestId for crate::operation::list_object_annotations::ListObjectAnnotationsError {
446    fn request_id(&self) -> Option<&str> {
447        self.meta().request_id()
448    }
449}
450
451pub use crate::operation::list_object_annotations::_list_object_annotations_input::ListObjectAnnotationsInput;
452
453pub use crate::operation::list_object_annotations::_list_object_annotations_output::ListObjectAnnotationsOutput;
454
455mod _list_object_annotations_input;
456
457mod _list_object_annotations_output;
458
459/// Builders
460pub mod builders;
461
462/// Paginator for this operation
463pub mod paginator;
aws_sdk_s3/operation/list_object_annotations.rs

aws_sdk_s3/operation/
list_object_annotations.rs
