aws_sdk_sagemakerruntime/operation/
invoke_endpoint.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `InvokeEndpoint`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct InvokeEndpoint;
6impl InvokeEndpoint {
7    /// Creates a new `InvokeEndpoint`
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::invoke_endpoint::InvokeEndpointInput,
14    ) -> ::std::result::Result<
15        crate::operation::invoke_endpoint::InvokeEndpointOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::invoke_endpoint::InvokeEndpointError,
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::invoke_endpoint::InvokeEndpointError>()
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::invoke_endpoint::InvokeEndpointOutput>()
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::invoke_endpoint::InvokeEndpointInput,
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("SageMaker Runtime", "InvokeEndpoint", 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                "SageMaker Runtime.InvokeEndpoint",
59                "rpc.service" = "SageMaker Runtime",
60                "rpc.method" = "InvokeEndpoint",
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 InvokeEndpoint {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("InvokeEndpoint");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            InvokeEndpointRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            InvokeEndpointResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("InvokeEndpoint")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
107            "InvokeEndpoint",
108            "SageMaker Runtime",
109        ));
110        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
111        signing_options.double_uri_encode = true;
112        signing_options.content_sha256_header = false;
113        signing_options.normalize_uri_path = true;
114        signing_options.payload_override = None;
115
116        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
117            signing_options,
118            ..::std::default::Default::default()
119        });
120
121        ::std::option::Option::Some(cfg.freeze())
122    }
123
124    fn runtime_components(
125        &self,
126        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
127    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
128        #[allow(unused_mut)]
129        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("InvokeEndpoint")
130            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131            .with_interceptor(InvokeEndpointEndpointParamsInterceptor)
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::invoke_endpoint::InvokeEndpointError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::invoke_endpoint::InvokeEndpointError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::invoke_endpoint::InvokeEndpointError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct InvokeEndpointResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for InvokeEndpointResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 200 || force_error {
160            crate::protocol_serde::shape_invoke_endpoint::de_invoke_endpoint_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_invoke_endpoint::de_invoke_endpoint_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct InvokeEndpointRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for InvokeEndpointRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::invoke_endpoint::InvokeEndpointInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            fn uri_base(
185                _input: &crate::operation::invoke_endpoint::InvokeEndpointInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.endpoint_name;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("endpoint_name", "cannot be empty or unset"))?;
193                let endpoint_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if endpoint_name.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "endpoint_name",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(output, "/endpoints/{EndpointName}/invocations", EndpointName = endpoint_name).expect("formatting should succeed");
201                ::std::result::Result::Ok(())
202            }
203            #[allow(clippy::unnecessary_wraps)]
204            fn update_http_builder(
205                input: &crate::operation::invoke_endpoint::InvokeEndpointInput,
206                builder: ::http::request::Builder,
207            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
208                let mut uri = ::std::string::String::new();
209                uri_base(input, &mut uri)?;
210                let builder = crate::protocol_serde::shape_invoke_endpoint::ser_invoke_endpoint_headers(input, builder)?;
211                ::std::result::Result::Ok(builder.method("POST").uri(uri))
212            }
213            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
214            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/octet-stream");
215            builder
216        };
217        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_invoke_endpoint_input::ser_body_http_payload(input.body)?);
218        if let Some(content_length) = body.content_length() {
219            let content_length = content_length.to_string();
220            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
221        }
222        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
223    }
224}
225#[derive(Debug)]
226struct InvokeEndpointEndpointParamsInterceptor;
227
228impl ::aws_smithy_runtime_api::client::interceptors::Intercept for InvokeEndpointEndpointParamsInterceptor {
229    fn name(&self) -> &'static str {
230        "InvokeEndpointEndpointParamsInterceptor"
231    }
232
233    fn read_before_execution(
234        &self,
235        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
236            '_,
237            ::aws_smithy_runtime_api::client::interceptors::context::Input,
238            ::aws_smithy_runtime_api::client::interceptors::context::Output,
239            ::aws_smithy_runtime_api::client::interceptors::context::Error,
240        >,
241        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
242    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
243        let _input = context
244            .input()
245            .downcast_ref::<InvokeEndpointInput>()
246            .ok_or("failed to downcast to InvokeEndpointInput")?;
247
248        let params = crate::config::endpoint::Params::builder()
249            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
250            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
251            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
252            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
253            .build()
254            .map_err(|err| {
255                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
256            })?;
257        cfg.interceptor_state()
258            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
259        ::std::result::Result::Ok(())
260    }
261}
262
263// The get_* functions below are generated from JMESPath expressions in the
264// operationContextParams trait. They target the operation's input shape.
265
266/// Error type for the `InvokeEndpointError` operation.
267#[non_exhaustive]
268#[derive(::std::fmt::Debug)]
269pub enum InvokeEndpointError {
270    /// <p>Your request caused an exception with an internal dependency. Contact customer support.</p>
271    InternalDependencyException(crate::types::error::InternalDependencyException),
272    /// <p>An internal failure occurred.</p>
273    InternalFailure(crate::types::error::InternalFailure),
274    /// <p>Model (owned by the customer in the container) returned 4xx or 5xx error code.</p>
275    ModelError(crate::types::error::ModelError),
276    /// <p>Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.</p>
277    ModelNotReadyException(crate::types::error::ModelNotReadyException),
278    /// <p>The service is unavailable. Try your call again.</p>
279    ServiceUnavailable(crate::types::error::ServiceUnavailable),
280    /// <p>Inspect your request and try again.</p>
281    ValidationError(crate::types::error::ValidationError),
282    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
283    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
284    variable wildcard pattern and check `.code()`:
285     \
286    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
287     \
288    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-InvokeEndpointError) for what information is available for the error.")]
289    Unhandled(crate::error::sealed_unhandled::Unhandled),
290}
291impl InvokeEndpointError {
292    /// Creates the `InvokeEndpointError::Unhandled` variant from any error type.
293    pub fn unhandled(
294        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
295    ) -> Self {
296        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
297            source: err.into(),
298            meta: ::std::default::Default::default(),
299        })
300    }
301
302    /// Creates the `InvokeEndpointError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
303    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
304        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
305            source: err.clone().into(),
306            meta: err,
307        })
308    }
309    ///
310    /// Returns error metadata, which includes the error code, message,
311    /// request ID, and potentially additional information.
312    ///
313    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
314        match self {
315            Self::InternalDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::InternalFailure(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::ModelError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::ModelNotReadyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::ServiceUnavailable(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::ValidationError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::Unhandled(e) => &e.meta,
322        }
323    }
324    /// Returns `true` if the error kind is `InvokeEndpointError::InternalDependencyException`.
325    pub fn is_internal_dependency_exception(&self) -> bool {
326        matches!(self, Self::InternalDependencyException(_))
327    }
328    /// Returns `true` if the error kind is `InvokeEndpointError::InternalFailure`.
329    pub fn is_internal_failure(&self) -> bool {
330        matches!(self, Self::InternalFailure(_))
331    }
332    /// Returns `true` if the error kind is `InvokeEndpointError::ModelError`.
333    pub fn is_model_error(&self) -> bool {
334        matches!(self, Self::ModelError(_))
335    }
336    /// Returns `true` if the error kind is `InvokeEndpointError::ModelNotReadyException`.
337    pub fn is_model_not_ready_exception(&self) -> bool {
338        matches!(self, Self::ModelNotReadyException(_))
339    }
340    /// Returns `true` if the error kind is `InvokeEndpointError::ServiceUnavailable`.
341    pub fn is_service_unavailable(&self) -> bool {
342        matches!(self, Self::ServiceUnavailable(_))
343    }
344    /// Returns `true` if the error kind is `InvokeEndpointError::ValidationError`.
345    pub fn is_validation_error(&self) -> bool {
346        matches!(self, Self::ValidationError(_))
347    }
348}
349impl ::std::error::Error for InvokeEndpointError {
350    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
351        match self {
352            Self::InternalDependencyException(_inner) => ::std::option::Option::Some(_inner),
353            Self::InternalFailure(_inner) => ::std::option::Option::Some(_inner),
354            Self::ModelError(_inner) => ::std::option::Option::Some(_inner),
355            Self::ModelNotReadyException(_inner) => ::std::option::Option::Some(_inner),
356            Self::ServiceUnavailable(_inner) => ::std::option::Option::Some(_inner),
357            Self::ValidationError(_inner) => ::std::option::Option::Some(_inner),
358            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
359        }
360    }
361}
362impl ::std::fmt::Display for InvokeEndpointError {
363    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
364        match self {
365            Self::InternalDependencyException(_inner) => _inner.fmt(f),
366            Self::InternalFailure(_inner) => _inner.fmt(f),
367            Self::ModelError(_inner) => _inner.fmt(f),
368            Self::ModelNotReadyException(_inner) => _inner.fmt(f),
369            Self::ServiceUnavailable(_inner) => _inner.fmt(f),
370            Self::ValidationError(_inner) => _inner.fmt(f),
371            Self::Unhandled(_inner) => {
372                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
373                    write!(f, "unhandled error ({code})")
374                } else {
375                    f.write_str("unhandled error")
376                }
377            }
378        }
379    }
380}
381impl ::aws_smithy_types::retry::ProvideErrorKind for InvokeEndpointError {
382    fn code(&self) -> ::std::option::Option<&str> {
383        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
384    }
385    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
386        ::std::option::Option::None
387    }
388}
389impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for InvokeEndpointError {
390    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
391        match self {
392            Self::InternalDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::InternalFailure(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::ModelError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::ModelNotReadyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::ServiceUnavailable(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::ValidationError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::Unhandled(_inner) => &_inner.meta,
399        }
400    }
401}
402impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for InvokeEndpointError {
403    fn create_unhandled_error(
404        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
405        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
406    ) -> Self {
407        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
408            source,
409            meta: meta.unwrap_or_default(),
410        })
411    }
412}
413impl ::aws_types::request_id::RequestId for crate::operation::invoke_endpoint::InvokeEndpointError {
414    fn request_id(&self) -> Option<&str> {
415        self.meta().request_id()
416    }
417}
418
419pub use crate::operation::invoke_endpoint::_invoke_endpoint_output::InvokeEndpointOutput;
420
421pub use crate::operation::invoke_endpoint::_invoke_endpoint_input::InvokeEndpointInput;
422
423mod _invoke_endpoint_input;
424
425mod _invoke_endpoint_output;
426
427/// Builders
428pub mod builders;