aws_sdk_machinelearning/operation/
predict.rs

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

aws_sdk_machinelearning/operation/
predict.rs
