aws_sdk_rekognition/operation/search_faces/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::search_faces::_search_faces_output::SearchFacesOutputBuilder;
3
4pub use crate::operation::search_faces::_search_faces_input::SearchFacesInputBuilder;
5
6impl crate::operation::search_faces::builders::SearchFacesInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::search_faces::SearchFacesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::search_faces::SearchFacesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.search_faces();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SearchFaces`.
24///
25/// <p>For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the <code>IndexFaces</code> operation. The operation compares the features of the input face with faces in the specified collection.</p><note>
26/// <p>You can also search faces without indexing faces by using the <code>SearchFacesByImage</code> operation.</p>
27/// </note>
28/// <p>The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a <code>confidence</code> value for each face match, indicating the confidence that the specific face matches the input face.</p>
29/// <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.</p>
30/// <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code> action.</p>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct SearchFacesFluentBuilder {
33    handle: ::std::sync::Arc<crate::client::Handle>,
34    inner: crate::operation::search_faces::builders::SearchFacesInputBuilder,
35    config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38    crate::client::customize::internal::CustomizableSend<
39        crate::operation::search_faces::SearchFacesOutput,
40        crate::operation::search_faces::SearchFacesError,
41    > for SearchFacesFluentBuilder
42{
43    fn send(
44        self,
45        config_override: crate::config::Builder,
46    ) -> crate::client::customize::internal::BoxFuture<
47        crate::client::customize::internal::SendResult<
48            crate::operation::search_faces::SearchFacesOutput,
49            crate::operation::search_faces::SearchFacesError,
50        >,
51    > {
52        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53    }
54}
55impl SearchFacesFluentBuilder {
56    /// Creates a new `SearchFacesFluentBuilder`.
57    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58        Self {
59            handle,
60            inner: ::std::default::Default::default(),
61            config_override: ::std::option::Option::None,
62        }
63    }
64    /// Access the SearchFaces as a reference.
65    pub fn as_input(&self) -> &crate::operation::search_faces::builders::SearchFacesInputBuilder {
66        &self.inner
67    }
68    /// Sends the request and returns the response.
69    ///
70    /// If an error occurs, an `SdkError` will be returned with additional details that
71    /// can be matched against.
72    ///
73    /// By default, any retryable failures will be retried twice. Retry behavior
74    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75    /// set when configuring the client.
76    pub async fn send(
77        self,
78    ) -> ::std::result::Result<
79        crate::operation::search_faces::SearchFacesOutput,
80        ::aws_smithy_runtime_api::client::result::SdkError<
81            crate::operation::search_faces::SearchFacesError,
82            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83        >,
84    > {
85        let input = self
86            .inner
87            .build()
88            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89        let runtime_plugins = crate::operation::search_faces::SearchFaces::operation_runtime_plugins(
90            self.handle.runtime_plugins.clone(),
91            &self.handle.conf,
92            self.config_override,
93        );
94        crate::operation::search_faces::SearchFaces::orchestrate(&runtime_plugins, input).await
95    }
96
97    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98    pub fn customize(
99        self,
100    ) -> crate::client::customize::CustomizableOperation<
101        crate::operation::search_faces::SearchFacesOutput,
102        crate::operation::search_faces::SearchFacesError,
103        Self,
104    > {
105        crate::client::customize::CustomizableOperation::new(self)
106    }
107    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108        self.set_config_override(::std::option::Option::Some(config_override.into()));
109        self
110    }
111
112    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113        self.config_override = config_override;
114        self
115    }
116    /// <p>ID of the collection the face belongs to.</p>
117    pub fn collection_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.inner = self.inner.collection_id(input.into());
119        self
120    }
121    /// <p>ID of the collection the face belongs to.</p>
122    pub fn set_collection_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.inner = self.inner.set_collection_id(input);
124        self
125    }
126    /// <p>ID of the collection the face belongs to.</p>
127    pub fn get_collection_id(&self) -> &::std::option::Option<::std::string::String> {
128        self.inner.get_collection_id()
129    }
130    /// <p>ID of a face to find matches for in the collection.</p>
131    pub fn face_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.face_id(input.into());
133        self
134    }
135    /// <p>ID of a face to find matches for in the collection.</p>
136    pub fn set_face_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137        self.inner = self.inner.set_face_id(input);
138        self
139    }
140    /// <p>ID of a face to find matches for in the collection.</p>
141    pub fn get_face_id(&self) -> &::std::option::Option<::std::string::String> {
142        self.inner.get_face_id()
143    }
144    /// <p>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</p>
145    pub fn max_faces(mut self, input: i32) -> Self {
146        self.inner = self.inner.max_faces(input);
147        self
148    }
149    /// <p>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</p>
150    pub fn set_max_faces(mut self, input: ::std::option::Option<i32>) -> Self {
151        self.inner = self.inner.set_max_faces(input);
152        self
153    }
154    /// <p>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</p>
155    pub fn get_max_faces(&self) -> &::std::option::Option<i32> {
156        self.inner.get_max_faces()
157    }
158    /// <p>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>
159    pub fn face_match_threshold(mut self, input: f32) -> Self {
160        self.inner = self.inner.face_match_threshold(input);
161        self
162    }
163    /// <p>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>
164    pub fn set_face_match_threshold(mut self, input: ::std::option::Option<f32>) -> Self {
165        self.inner = self.inner.set_face_match_threshold(input);
166        self
167    }
168    /// <p>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>
169    pub fn get_face_match_threshold(&self) -> &::std::option::Option<f32> {
170        self.inner.get_face_match_threshold()
171    }
172}
aws_sdk_rekognition/operation/search_faces/builders.rs

aws_sdk_rekognition/operation/search_faces/
builders.rs
