aws_sdk_machinelearning/operation/
describe_ml_models.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeMLModels`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeMLModels;
6impl DescribeMLModels {
7    /// Creates a new `DescribeMLModels`
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::describe_ml_models::DescribeMlModelsInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_ml_models::DescribeMlModelsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_ml_models::DescribeMLModelsError,
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::describe_ml_models::DescribeMLModelsError>()
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::describe_ml_models::DescribeMlModelsOutput>()
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::describe_ml_models::DescribeMlModelsInput,
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("Machine Learning", "DescribeMLModels", 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                "Machine Learning.DescribeMLModels",
59                "rpc.service" = "Machine Learning",
60                "rpc.method" = "DescribeMLModels",
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 DescribeMLModels {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeMLModels");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeMLModelsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeMLModelsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeMLModels")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeMLModels",
107            "Machine Learning",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
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 = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeMLModels")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                DescribeMLModelsTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                DescribeMLModelsEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::describe_ml_models::DescribeMLModelsError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::describe_ml_models::DescribeMLModelsError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::describe_ml_models::DescribeMLModelsError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct DescribeMLModelsTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeMLModelsTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "DescribeMLModelsTelemetryInputCaptureInterceptor"
159    }
160
161    fn read_before_execution(
162        &self,
163        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
164            '_,
165            ::aws_smithy_runtime_api::client::interceptors::context::Input,
166            ::aws_smithy_runtime_api::client::interceptors::context::Output,
167            ::aws_smithy_runtime_api::client::interceptors::context::Error,
168        >,
169        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
171        // Nothing to do unless the customer opted in by naming members to record.
172        let ::std::option::Option::Some(requested) = cfg
173            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
174            .filter(|r| !r.is_empty())
175        else {
176            return ::std::result::Result::Ok(());
177        };
178
179        let ::std::option::Option::Some(input) = context.input().downcast_ref::<DescribeMlModelsInput>() else {
180            // A mismatched input is not this interceptor's concern; skip quietly.
181            return ::std::result::Result::Ok(());
182        };
183
184        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185        if requested.should_capture("EQ") {
186            if let ::std::option::Option::Some(value) = input.eq.as_deref() {
187                captured.insert("EQ", value);
188            }
189        }
190        if requested.should_capture("GT") {
191            if let ::std::option::Option::Some(value) = input.gt.as_deref() {
192                captured.insert("GT", value);
193            }
194        }
195        if requested.should_capture("LT") {
196            if let ::std::option::Option::Some(value) = input.lt.as_deref() {
197                captured.insert("LT", value);
198            }
199        }
200        if requested.should_capture("GE") {
201            if let ::std::option::Option::Some(value) = input.ge.as_deref() {
202                captured.insert("GE", value);
203            }
204        }
205        if requested.should_capture("LE") {
206            if let ::std::option::Option::Some(value) = input.le.as_deref() {
207                captured.insert("LE", value);
208            }
209        }
210        if requested.should_capture("NE") {
211            if let ::std::option::Option::Some(value) = input.ne.as_deref() {
212                captured.insert("NE", value);
213            }
214        }
215        if requested.should_capture("Prefix") {
216            if let ::std::option::Option::Some(value) = input.prefix.as_deref() {
217                captured.insert("Prefix", value);
218            }
219        }
220        if requested.should_capture("NextToken") {
221            if let ::std::option::Option::Some(value) = input.next_token.as_deref() {
222                captured.insert("NextToken", value);
223            }
224        }
225
226        cfg.interceptor_state().store_put(captured);
227        ::std::result::Result::Ok(())
228    }
229}
230#[derive(Debug)]
231struct DescribeMLModelsResponseDeserializer;
232impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeMLModelsResponseDeserializer {
233    fn deserialize_nonstreaming_with_config(
234        &self,
235        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
236        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
237    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
238        let (success, status) = (response.status().is_success(), response.status().as_u16());
239        let headers = response.headers();
240        let body = response.body().bytes().expect("body loaded");
241        #[allow(unused_mut)]
242        let mut force_error = false;
243        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
244        let parse_result = if !success && status != 200 || force_error {
245            crate::protocol_serde::shape_describe_ml_models::de_describe_ml_models_http_error(status, headers, body)
246        } else {
247            crate::protocol_serde::shape_describe_ml_models::de_describe_ml_models_http_response(status, headers, body)
248        };
249        crate::protocol_serde::type_erase_result(parse_result)
250    }
251}
252#[derive(Debug)]
253struct DescribeMLModelsRequestSerializer;
254impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeMLModelsRequestSerializer {
255    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
256    fn serialize_input(
257        &self,
258        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
259        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
260    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
261        let input = input
262            .downcast::<crate::operation::describe_ml_models::DescribeMlModelsInput>()
263            .expect("correct type");
264        let _header_serialization_settings = _cfg
265            .load::<crate::serialization_settings::HeaderSerializationSettings>()
266            .cloned()
267            .unwrap_or_default();
268        let mut request_builder = {
269            #[allow(clippy::uninlined_format_args)]
270            fn uri_base(
271                _input: &crate::operation::describe_ml_models::DescribeMlModelsInput,
272                output: &mut ::std::string::String,
273            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
274                use ::std::fmt::Write as _;
275                ::std::write!(output, "/").expect("formatting should succeed");
276                ::std::result::Result::Ok(())
277            }
278            #[allow(clippy::unnecessary_wraps)]
279            fn update_http_builder(
280                input: &crate::operation::describe_ml_models::DescribeMlModelsInput,
281                builder: ::http_1x::request::Builder,
282            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
283                let mut uri = ::std::string::String::new();
284                uri_base(input, &mut uri)?;
285                ::std::result::Result::Ok(builder.method("POST").uri(uri))
286            }
287            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
288            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
289            builder = _header_serialization_settings.set_default_header(
290                builder,
291                ::http_1x::header::HeaderName::from_static("x-amz-target"),
292                "AmazonML_20141212.DescribeMLModels",
293            );
294            builder
295        };
296        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_ml_models::ser_describe_ml_models_input(&input)?);
297        if let Some(content_length) = body.content_length() {
298            let content_length = content_length.to_string();
299            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
300        }
301        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
302    }
303}
304#[derive(Debug)]
305struct DescribeMLModelsEndpointParamsInterceptor;
306
307#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
308impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeMLModelsEndpointParamsInterceptor {
309    fn name(&self) -> &'static str {
310        "DescribeMLModelsEndpointParamsInterceptor"
311    }
312
313    fn read_before_execution(
314        &self,
315        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
316            '_,
317            ::aws_smithy_runtime_api::client::interceptors::context::Input,
318            ::aws_smithy_runtime_api::client::interceptors::context::Output,
319            ::aws_smithy_runtime_api::client::interceptors::context::Error,
320        >,
321        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
322    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
323        let _input = context
324            .input()
325            .downcast_ref::<DescribeMlModelsInput>()
326            .ok_or("failed to downcast to DescribeMlModelsInput")?;
327
328        let params = crate::config::endpoint::Params::builder()
329            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
330            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
331            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
332            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
333            .build()
334            .map_err(|err| {
335                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
336            })?;
337        cfg.interceptor_state()
338            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
339        ::std::result::Result::Ok(())
340    }
341}
342
343// The get_* functions below are generated from JMESPath expressions in the
344// operationContextParams trait. They target the operation's input shape.
345
346/// Error type for the `DescribeMLModelsError` operation.
347#[non_exhaustive]
348#[derive(::std::fmt::Debug)]
349pub enum DescribeMLModelsError {
350    /// <p>An error on the server occurred when trying to process a request.</p>
351    InternalServerException(crate::types::error::InternalServerException),
352    /// <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
353    InvalidInputException(crate::types::error::InvalidInputException),
354    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
355    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
356    variable wildcard pattern and check `.code()`:
357     \
358    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
359     \
360    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeMLModelsError) for what information is available for the error.")]
361    Unhandled(crate::error::sealed_unhandled::Unhandled),
362}
363impl DescribeMLModelsError {
364    /// Creates the `DescribeMLModelsError::Unhandled` variant from any error type.
365    pub fn unhandled(
366        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
367    ) -> Self {
368        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
369            source: err.into(),
370            meta: ::std::default::Default::default(),
371        })
372    }
373
374    /// Creates the `DescribeMLModelsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
375    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
376        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
377            source: err.clone().into(),
378            meta: err,
379        })
380    }
381    ///
382    /// Returns error metadata, which includes the error code, message,
383    /// request ID, and potentially additional information.
384    ///
385    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
386        match self {
387            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
388            Self::InvalidInputException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
389            Self::Unhandled(e) => &e.meta,
390        }
391    }
392    /// Returns `true` if the error kind is `DescribeMLModelsError::InternalServerException`.
393    pub fn is_internal_server_exception(&self) -> bool {
394        matches!(self, Self::InternalServerException(_))
395    }
396    /// Returns `true` if the error kind is `DescribeMLModelsError::InvalidInputException`.
397    pub fn is_invalid_input_exception(&self) -> bool {
398        matches!(self, Self::InvalidInputException(_))
399    }
400}
401impl ::std::error::Error for DescribeMLModelsError {
402    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
403        match self {
404            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
405            Self::InvalidInputException(_inner) => ::std::option::Option::Some(_inner),
406            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
407        }
408    }
409}
410impl ::std::fmt::Display for DescribeMLModelsError {
411    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
412        match self {
413            Self::InternalServerException(_inner) => _inner.fmt(f),
414            Self::InvalidInputException(_inner) => _inner.fmt(f),
415            Self::Unhandled(_inner) => {
416                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
417                    write!(f, "unhandled error ({code})")
418                } else {
419                    f.write_str("unhandled error")
420                }
421            }
422        }
423    }
424}
425impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeMLModelsError {
426    fn code(&self) -> ::std::option::Option<&str> {
427        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
428    }
429    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
430        ::std::option::Option::None
431    }
432}
433impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeMLModelsError {
434    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
435        match self {
436            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
437            Self::InvalidInputException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
438            Self::Unhandled(_inner) => &_inner.meta,
439        }
440    }
441}
442impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeMLModelsError {
443    fn create_unhandled_error(
444        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
445        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
446    ) -> Self {
447        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
448            source,
449            meta: meta.unwrap_or_default(),
450        })
451    }
452}
453impl ::aws_types::request_id::RequestId for crate::operation::describe_ml_models::DescribeMLModelsError {
454    fn request_id(&self) -> Option<&str> {
455        self.meta().request_id()
456    }
457}
458
459pub use crate::operation::describe_ml_models::_describe_ml_models_input::DescribeMlModelsInput;
460
461pub use crate::operation::describe_ml_models::_describe_ml_models_output::DescribeMlModelsOutput;
462
463mod _describe_ml_models_input;
464
465mod _describe_ml_models_output;
466
467/// Builders
468pub mod builders;
469
470/// Paginator for this operation
471pub mod paginator;
aws_sdk_machinelearning/operation/describe_ml_models.rs

aws_sdk_machinelearning/operation/
describe_ml_models.rs
