Skip to main content

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