aws_sdk_rekognition/operation/
compare_faces.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `CompareFaces`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct CompareFaces;
6impl CompareFaces {
7    /// Creates a new `CompareFaces`
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::compare_faces::CompareFacesInput,
14    ) -> ::std::result::Result<
15        crate::operation::compare_faces::CompareFacesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::compare_faces::CompareFacesError,
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::compare_faces::CompareFacesError>()
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::compare_faces::CompareFacesOutput>()
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::compare_faces::CompareFacesInput,
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("Rekognition", "CompareFaces", 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                "Rekognition.CompareFaces",
59                "rpc.service" = "Rekognition",
60                "rpc.method" = "CompareFaces",
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 CompareFaces {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CompareFaces");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            CompareFacesRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            CompareFacesResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("CompareFaces")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "CompareFaces",
107            "Rekognition",
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("CompareFaces")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(CompareFacesEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::compare_faces::CompareFacesError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::compare_faces::CompareFacesError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::compare_faces::CompareFacesError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct CompareFacesResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CompareFacesResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_compare_faces::de_compare_faces_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_compare_faces::de_compare_faces_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct CompareFacesRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CompareFacesRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::compare_faces::CompareFacesInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            #[allow(clippy::uninlined_format_args)]
184            fn uri_base(
185                _input: &crate::operation::compare_faces::CompareFacesInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                ::std::write!(output, "/").expect("formatting should succeed");
190                ::std::result::Result::Ok(())
191            }
192            #[allow(clippy::unnecessary_wraps)]
193            fn update_http_builder(
194                input: &crate::operation::compare_faces::CompareFacesInput,
195                builder: ::http::request::Builder,
196            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
197                let mut uri = ::std::string::String::new();
198                uri_base(input, &mut uri)?;
199                ::std::result::Result::Ok(builder.method("POST").uri(uri))
200            }
201            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
202            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
203            builder = _header_serialization_settings.set_default_header(
204                builder,
205                ::http::header::HeaderName::from_static("x-amz-target"),
206                "RekognitionService.CompareFaces",
207            );
208            builder
209        };
210        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_compare_faces::ser_compare_faces_input(&input)?);
211        if let Some(content_length) = body.content_length() {
212            let content_length = content_length.to_string();
213            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
214        }
215        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
216    }
217}
218#[derive(Debug)]
219struct CompareFacesEndpointParamsInterceptor;
220
221impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CompareFacesEndpointParamsInterceptor {
222    fn name(&self) -> &'static str {
223        "CompareFacesEndpointParamsInterceptor"
224    }
225
226    fn read_before_execution(
227        &self,
228        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
229            '_,
230            ::aws_smithy_runtime_api::client::interceptors::context::Input,
231            ::aws_smithy_runtime_api::client::interceptors::context::Output,
232            ::aws_smithy_runtime_api::client::interceptors::context::Error,
233        >,
234        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
235    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
236        let _input = context
237            .input()
238            .downcast_ref::<CompareFacesInput>()
239            .ok_or("failed to downcast to CompareFacesInput")?;
240
241        let params = crate::config::endpoint::Params::builder()
242            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
243            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
244            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
245            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
246            .build()
247            .map_err(|err| {
248                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
249            })?;
250        cfg.interceptor_state()
251            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
252        ::std::result::Result::Ok(())
253    }
254}
255
256// The get_* functions below are generated from JMESPath expressions in the
257// operationContextParams trait. They target the operation's input shape.
258
259/// Error type for the `CompareFacesError` operation.
260#[non_exhaustive]
261#[derive(::std::fmt::Debug)]
262pub enum CompareFacesError {
263    /// <p>You are not authorized to perform the action.</p>
264    AccessDeniedException(crate::types::error::AccessDeniedException),
265    /// <p>The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.</p>
266    ImageTooLargeException(crate::types::error::ImageTooLargeException),
267    /// <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
268    InternalServerError(crate::types::error::InternalServerError),
269    /// <p>The provided image format is not supported.</p>
270    InvalidImageFormatException(crate::types::error::InvalidImageFormatException),
271    /// <p>Input parameter violated a constraint. Validate your parameter before calling the API operation again.</p>
272    InvalidParameterException(crate::types::error::InvalidParameterException),
273    /// <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
274    InvalidS3ObjectException(crate::types::error::InvalidS3ObjectException),
275    /// <p>The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.</p>
276    ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
277    /// <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
278    ThrottlingException(crate::types::error::ThrottlingException),
279    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
280    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
281    variable wildcard pattern and check `.code()`:
282     \
283    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
284     \
285    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CompareFacesError) for what information is available for the error.")]
286    Unhandled(crate::error::sealed_unhandled::Unhandled),
287}
288impl CompareFacesError {
289    /// Creates the `CompareFacesError::Unhandled` variant from any error type.
290    pub fn unhandled(
291        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
292    ) -> Self {
293        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
294            source: err.into(),
295            meta: ::std::default::Default::default(),
296        })
297    }
298
299    /// Creates the `CompareFacesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
300    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
301        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
302            source: err.clone().into(),
303            meta: err,
304        })
305    }
306    ///
307    /// Returns error metadata, which includes the error code, message,
308    /// request ID, and potentially additional information.
309    ///
310    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
311        match self {
312            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::ImageTooLargeException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::InvalidImageFormatException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::InvalidS3ObjectException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::Unhandled(e) => &e.meta,
321        }
322    }
323    /// Returns `true` if the error kind is `CompareFacesError::AccessDeniedException`.
324    pub fn is_access_denied_exception(&self) -> bool {
325        matches!(self, Self::AccessDeniedException(_))
326    }
327    /// Returns `true` if the error kind is `CompareFacesError::ImageTooLargeException`.
328    pub fn is_image_too_large_exception(&self) -> bool {
329        matches!(self, Self::ImageTooLargeException(_))
330    }
331    /// Returns `true` if the error kind is `CompareFacesError::InternalServerError`.
332    pub fn is_internal_server_error(&self) -> bool {
333        matches!(self, Self::InternalServerError(_))
334    }
335    /// Returns `true` if the error kind is `CompareFacesError::InvalidImageFormatException`.
336    pub fn is_invalid_image_format_exception(&self) -> bool {
337        matches!(self, Self::InvalidImageFormatException(_))
338    }
339    /// Returns `true` if the error kind is `CompareFacesError::InvalidParameterException`.
340    pub fn is_invalid_parameter_exception(&self) -> bool {
341        matches!(self, Self::InvalidParameterException(_))
342    }
343    /// Returns `true` if the error kind is `CompareFacesError::InvalidS3ObjectException`.
344    pub fn is_invalid_s3_object_exception(&self) -> bool {
345        matches!(self, Self::InvalidS3ObjectException(_))
346    }
347    /// Returns `true` if the error kind is `CompareFacesError::ProvisionedThroughputExceededException`.
348    pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
349        matches!(self, Self::ProvisionedThroughputExceededException(_))
350    }
351    /// Returns `true` if the error kind is `CompareFacesError::ThrottlingException`.
352    pub fn is_throttling_exception(&self) -> bool {
353        matches!(self, Self::ThrottlingException(_))
354    }
355}
356impl ::std::error::Error for CompareFacesError {
357    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
358        match self {
359            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
360            Self::ImageTooLargeException(_inner) => ::std::option::Option::Some(_inner),
361            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
362            Self::InvalidImageFormatException(_inner) => ::std::option::Option::Some(_inner),
363            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
364            Self::InvalidS3ObjectException(_inner) => ::std::option::Option::Some(_inner),
365            Self::ProvisionedThroughputExceededException(_inner) => ::std::option::Option::Some(_inner),
366            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
367            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
368        }
369    }
370}
371impl ::std::fmt::Display for CompareFacesError {
372    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
373        match self {
374            Self::AccessDeniedException(_inner) => _inner.fmt(f),
375            Self::ImageTooLargeException(_inner) => _inner.fmt(f),
376            Self::InternalServerError(_inner) => _inner.fmt(f),
377            Self::InvalidImageFormatException(_inner) => _inner.fmt(f),
378            Self::InvalidParameterException(_inner) => _inner.fmt(f),
379            Self::InvalidS3ObjectException(_inner) => _inner.fmt(f),
380            Self::ProvisionedThroughputExceededException(_inner) => _inner.fmt(f),
381            Self::ThrottlingException(_inner) => _inner.fmt(f),
382            Self::Unhandled(_inner) => {
383                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
384                    write!(f, "unhandled error ({code})")
385                } else {
386                    f.write_str("unhandled error")
387                }
388            }
389        }
390    }
391}
392impl ::aws_smithy_types::retry::ProvideErrorKind for CompareFacesError {
393    fn code(&self) -> ::std::option::Option<&str> {
394        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
395    }
396    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
397        ::std::option::Option::None
398    }
399}
400impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CompareFacesError {
401    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
402        match self {
403            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::ImageTooLargeException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::InvalidImageFormatException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::InvalidS3ObjectException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::ProvisionedThroughputExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::Unhandled(_inner) => &_inner.meta,
412        }
413    }
414}
415impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CompareFacesError {
416    fn create_unhandled_error(
417        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
418        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
419    ) -> Self {
420        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
421            source,
422            meta: meta.unwrap_or_default(),
423        })
424    }
425}
426impl ::aws_types::request_id::RequestId for crate::operation::compare_faces::CompareFacesError {
427    fn request_id(&self) -> Option<&str> {
428        self.meta().request_id()
429    }
430}
431
432pub use crate::operation::compare_faces::_compare_faces_output::CompareFacesOutput;
433
434pub use crate::operation::compare_faces::_compare_faces_input::CompareFacesInput;
435
436mod _compare_faces_input;
437
438mod _compare_faces_output;
439
440/// Builders
441pub mod builders;
aws_sdk_rekognition/operation/compare_faces.rs

aws_sdk_rekognition/operation/
compare_faces.rs
