aws_sdk_s3vectors/operation/
get_index.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetIndex`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetIndex;
6impl GetIndex {
7    /// Creates a new `GetIndex`
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::get_index::GetIndexInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_index::GetIndexOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_index::GetIndexError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_index::GetIndexError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::get_index::GetIndexOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::get_index::GetIndexInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        use ::tracing::Instrument;
50        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("S3Vectors", "GetIndex", input, runtime_plugins, stop_point)
51            // Create a parent span for the entire operation. Includes a random, internal-only,
52            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
53            .instrument(::tracing::debug_span!(
54                "S3Vectors.GetIndex",
55                "rpc.service" = "S3Vectors",
56                "rpc.method" = "GetIndex",
57                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
58                "rpc.system" = "aws-api",
59            ))
60            .await
61    }
62
63    pub(crate) fn operation_runtime_plugins(
64        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
65        client_config: &crate::config::Config,
66        config_override: ::std::option::Option<crate::config::Builder>,
67    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
68        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
69
70        if let ::std::option::Option::Some(config_override) = config_override {
71            for plugin in config_override.runtime_plugins.iter().cloned() {
72                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
73            }
74            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
75                config_override,
76                client_config.config.clone(),
77                &client_config.runtime_components,
78            ));
79        }
80        runtime_plugins
81    }
82}
83impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetIndex {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetIndex");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            GetIndexRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            GetIndexResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("GetIndex")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetIndex", "S3Vectors"));
102        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
103        signing_options.double_uri_encode = true;
104        signing_options.content_sha256_header = false;
105        signing_options.normalize_uri_path = true;
106        signing_options.payload_override = None;
107
108        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
109            signing_options,
110            ..::std::default::Default::default()
111        });
112
113        ::std::option::Option::Some(cfg.freeze())
114    }
115
116    fn runtime_components(
117        &self,
118        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
119    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
120        #[allow(unused_mut)]
121        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetIndex")
122            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
123            .with_interceptor(GetIndexEndpointParamsInterceptor)
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
125                crate::operation::get_index::GetIndexError,
126            >::new())
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
128                crate::operation::get_index::GetIndexError,
129            >::new())
130            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
131                crate::operation::get_index::GetIndexError,
132            >::new());
133
134        ::std::borrow::Cow::Owned(rcb)
135    }
136}
137
138#[derive(Debug)]
139struct GetIndexResponseDeserializer;
140impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetIndexResponseDeserializer {
141    fn deserialize_nonstreaming(
142        &self,
143        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
144    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
145        let (success, status) = (response.status().is_success(), response.status().as_u16());
146        let headers = response.headers();
147        let body = response.body().bytes().expect("body loaded");
148        #[allow(unused_mut)]
149        let mut force_error = false;
150        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
151        let parse_result = if !success && status != 200 || force_error {
152            crate::protocol_serde::shape_get_index::de_get_index_http_error(status, headers, body)
153        } else {
154            crate::protocol_serde::shape_get_index::de_get_index_http_response(status, headers, body)
155        };
156        crate::protocol_serde::type_erase_result(parse_result)
157    }
158}
159#[derive(Debug)]
160struct GetIndexRequestSerializer;
161impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetIndexRequestSerializer {
162    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
163    fn serialize_input(
164        &self,
165        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
166        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
167    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
168        let input = input.downcast::<crate::operation::get_index::GetIndexInput>().expect("correct type");
169        let _header_serialization_settings = _cfg
170            .load::<crate::serialization_settings::HeaderSerializationSettings>()
171            .cloned()
172            .unwrap_or_default();
173        let mut request_builder = {
174            #[allow(clippy::uninlined_format_args)]
175            fn uri_base(
176                _input: &crate::operation::get_index::GetIndexInput,
177                output: &mut ::std::string::String,
178            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
179                use ::std::fmt::Write as _;
180                ::std::write!(output, "/GetIndex").expect("formatting should succeed");
181                ::std::result::Result::Ok(())
182            }
183            #[allow(clippy::unnecessary_wraps)]
184            fn update_http_builder(
185                input: &crate::operation::get_index::GetIndexInput,
186                builder: ::http::request::Builder,
187            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
188                let mut uri = ::std::string::String::new();
189                uri_base(input, &mut uri)?;
190                ::std::result::Result::Ok(builder.method("POST").uri(uri))
191            }
192            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
193            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
194            builder
195        };
196        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_index::ser_get_index_input(&input)?);
197        if let Some(content_length) = body.content_length() {
198            let content_length = content_length.to_string();
199            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
200        }
201        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
202    }
203}
204#[derive(Debug)]
205struct GetIndexEndpointParamsInterceptor;
206
207impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetIndexEndpointParamsInterceptor {
208    fn name(&self) -> &'static str {
209        "GetIndexEndpointParamsInterceptor"
210    }
211
212    fn read_before_execution(
213        &self,
214        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
215            '_,
216            ::aws_smithy_runtime_api::client::interceptors::context::Input,
217            ::aws_smithy_runtime_api::client::interceptors::context::Output,
218            ::aws_smithy_runtime_api::client::interceptors::context::Error,
219        >,
220        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
221    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
222        let _input = context
223            .input()
224            .downcast_ref::<GetIndexInput>()
225            .ok_or("failed to downcast to GetIndexInput")?;
226
227        let params = crate::config::endpoint::Params::builder()
228            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
229            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
230            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
231            .build()
232            .map_err(|err| {
233                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
234            })?;
235        cfg.interceptor_state()
236            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
237        ::std::result::Result::Ok(())
238    }
239}
240
241// The get_* functions below are generated from JMESPath expressions in the
242// operationContextParams trait. They target the operation's input shape.
243
244/// Error type for the `GetIndexError` operation.
245#[non_exhaustive]
246#[derive(::std::fmt::Debug)]
247pub enum GetIndexError {
248    /// <p>The request was rejected because the specified resource can't be found.</p>
249    NotFoundException(crate::types::error::NotFoundException),
250    /// <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
251    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
252    /// <p>Access denied.</p>
253    AccessDeniedException(crate::types::error::AccessDeniedException),
254    /// <p>The request failed due to an internal server error.</p>
255    InternalServerException(crate::types::error::InternalServerException),
256    /// <p>The request timed out. Retry your request.</p>
257    RequestTimeoutException(crate::types::error::RequestTimeoutException),
258    /// <p>The request was denied due to request throttling.</p>
259    TooManyRequestsException(crate::types::error::TooManyRequestsException),
260    /// <p>The requested action isn't valid.</p>
261    ValidationException(crate::types::error::ValidationException),
262    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
263    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
264    variable wildcard pattern and check `.code()`:
265     \
266    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
267     \
268    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetIndexError) for what information is available for the error.")]
269    Unhandled(crate::error::sealed_unhandled::Unhandled),
270}
271impl GetIndexError {
272    /// Creates the `GetIndexError::Unhandled` variant from any error type.
273    pub fn unhandled(
274        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
275    ) -> Self {
276        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
277            source: err.into(),
278            meta: ::std::default::Default::default(),
279        })
280    }
281
282    /// Creates the `GetIndexError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
283    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
284        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
285            source: err.clone().into(),
286            meta: err,
287        })
288    }
289    ///
290    /// Returns error metadata, which includes the error code, message,
291    /// request ID, and potentially additional information.
292    ///
293    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
294        match self {
295            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
297            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
298            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::RequestTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::Unhandled(e) => &e.meta,
303        }
304    }
305    /// Returns `true` if the error kind is `GetIndexError::NotFoundException`.
306    pub fn is_not_found_exception(&self) -> bool {
307        matches!(self, Self::NotFoundException(_))
308    }
309    /// Returns `true` if the error kind is `GetIndexError::ServiceUnavailableException`.
310    pub fn is_service_unavailable_exception(&self) -> bool {
311        matches!(self, Self::ServiceUnavailableException(_))
312    }
313    /// Returns `true` if the error kind is `GetIndexError::AccessDeniedException`.
314    pub fn is_access_denied_exception(&self) -> bool {
315        matches!(self, Self::AccessDeniedException(_))
316    }
317    /// Returns `true` if the error kind is `GetIndexError::InternalServerException`.
318    pub fn is_internal_server_exception(&self) -> bool {
319        matches!(self, Self::InternalServerException(_))
320    }
321    /// Returns `true` if the error kind is `GetIndexError::RequestTimeoutException`.
322    pub fn is_request_timeout_exception(&self) -> bool {
323        matches!(self, Self::RequestTimeoutException(_))
324    }
325    /// Returns `true` if the error kind is `GetIndexError::TooManyRequestsException`.
326    pub fn is_too_many_requests_exception(&self) -> bool {
327        matches!(self, Self::TooManyRequestsException(_))
328    }
329    /// Returns `true` if the error kind is `GetIndexError::ValidationException`.
330    pub fn is_validation_exception(&self) -> bool {
331        matches!(self, Self::ValidationException(_))
332    }
333}
334impl ::std::error::Error for GetIndexError {
335    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
336        match self {
337            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
338            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
339            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
340            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
341            Self::RequestTimeoutException(_inner) => ::std::option::Option::Some(_inner),
342            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
343            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
344            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
345        }
346    }
347}
348impl ::std::fmt::Display for GetIndexError {
349    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
350        match self {
351            Self::NotFoundException(_inner) => _inner.fmt(f),
352            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
353            Self::AccessDeniedException(_inner) => _inner.fmt(f),
354            Self::InternalServerException(_inner) => _inner.fmt(f),
355            Self::RequestTimeoutException(_inner) => _inner.fmt(f),
356            Self::TooManyRequestsException(_inner) => _inner.fmt(f),
357            Self::ValidationException(_inner) => _inner.fmt(f),
358            Self::Unhandled(_inner) => {
359                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
360                    write!(f, "unhandled error ({code})")
361                } else {
362                    f.write_str("unhandled error")
363                }
364            }
365        }
366    }
367}
368impl ::aws_smithy_types::retry::ProvideErrorKind for GetIndexError {
369    fn code(&self) -> ::std::option::Option<&str> {
370        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
371    }
372    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
373        match self {
374            Self::ServiceUnavailableException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
375            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
376            Self::RequestTimeoutException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
377            Self::TooManyRequestsException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
378            _ => ::std::option::Option::None,
379        }
380    }
381}
382impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetIndexError {
383    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
384        match self {
385            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
386            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
387            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::RequestTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::Unhandled(_inner) => &_inner.meta,
393        }
394    }
395}
396impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetIndexError {
397    fn create_unhandled_error(
398        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
399        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
400    ) -> Self {
401        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
402            source,
403            meta: meta.unwrap_or_default(),
404        })
405    }
406}
407impl ::aws_types::request_id::RequestId for crate::operation::get_index::GetIndexError {
408    fn request_id(&self) -> Option<&str> {
409        self.meta().request_id()
410    }
411}
412
413pub use crate::operation::get_index::_get_index_output::GetIndexOutput;
414
415pub use crate::operation::get_index::_get_index_input::GetIndexInput;
416
417mod _get_index_input;
418
419mod _get_index_output;
420
421/// Builders
422pub mod builders;
aws_sdk_s3vectors/operation/get_index.rs

aws_sdk_s3vectors/operation/
get_index.rs
