aws_sdk_rekognition/operation/start_face_search/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_face_search::_start_face_search_output::StartFaceSearchOutputBuilder;
3
4pub use crate::operation::start_face_search::_start_face_search_input::StartFaceSearchInputBuilder;
5
6impl crate::operation::start_face_search::builders::StartFaceSearchInputBuilder {
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::start_face_search::StartFaceSearchOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::start_face_search::StartFaceSearchError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.start_face_search();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `StartFaceSearch`.
24///
25/// <p>Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.</p>
26/// <p>The video must be stored in an Amazon S3 bucket. Use <code>Video</code> to specify the bucket name and the filename of the video. <code>StartFaceSearch</code> returns a job identifier (<code>JobId</code>) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. To get the search results, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html">Searching stored videos for faces</a>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct StartFaceSearchFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::start_face_search::builders::StartFaceSearchInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::start_face_search::StartFaceSearchOutput,
36 crate::operation::start_face_search::StartFaceSearchError,
37 > for StartFaceSearchFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::start_face_search::StartFaceSearchOutput,
45 crate::operation::start_face_search::StartFaceSearchError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl StartFaceSearchFluentBuilder {
52 /// Creates a new `StartFaceSearchFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the StartFaceSearch as a reference.
61 pub fn as_input(&self) -> &crate::operation::start_face_search::builders::StartFaceSearchInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::start_face_search::StartFaceSearchOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::start_face_search::StartFaceSearchError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::start_face_search::StartFaceSearch::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::start_face_search::StartFaceSearch::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::start_face_search::StartFaceSearchOutput,
98 crate::operation::start_face_search::StartFaceSearchError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// <p>The video you want to search. The video must be stored in an Amazon S3 bucket.</p>
113 pub fn video(mut self, input: crate::types::Video) -> Self {
114 self.inner = self.inner.video(input);
115 self
116 }
117 /// <p>The video you want to search. The video must be stored in an Amazon S3 bucket.</p>
118 pub fn set_video(mut self, input: ::std::option::Option<crate::types::Video>) -> Self {
119 self.inner = self.inner.set_video(input);
120 self
121 }
122 /// <p>The video you want to search. The video must be stored in an Amazon S3 bucket.</p>
123 pub fn get_video(&self) -> &::std::option::Option<crate::types::Video> {
124 self.inner.get_video()
125 }
126 /// <p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.</p>
127 pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128 self.inner = self.inner.client_request_token(input.into());
129 self
130 }
131 /// <p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.</p>
132 pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133 self.inner = self.inner.set_client_request_token(input);
134 self
135 }
136 /// <p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.</p>
137 pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
138 self.inner.get_client_request_token()
139 }
140 /// <p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>
141 pub fn face_match_threshold(mut self, input: f32) -> Self {
142 self.inner = self.inner.face_match_threshold(input);
143 self
144 }
145 /// <p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>
146 pub fn set_face_match_threshold(mut self, input: ::std::option::Option<f32>) -> Self {
147 self.inner = self.inner.set_face_match_threshold(input);
148 self
149 }
150 /// <p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>
151 pub fn get_face_match_threshold(&self) -> &::std::option::Option<f32> {
152 self.inner.get_face_match_threshold()
153 }
154 /// <p>ID of the collection that contains the faces you want to search for.</p>
155 pub fn collection_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
156 self.inner = self.inner.collection_id(input.into());
157 self
158 }
159 /// <p>ID of the collection that contains the faces you want to search for.</p>
160 pub fn set_collection_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
161 self.inner = self.inner.set_collection_id(input);
162 self
163 }
164 /// <p>ID of the collection that contains the faces you want to search for.</p>
165 pub fn get_collection_id(&self) -> &::std::option::Option<::std::string::String> {
166 self.inner.get_collection_id()
167 }
168 /// <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>
169 pub fn notification_channel(mut self, input: crate::types::NotificationChannel) -> Self {
170 self.inner = self.inner.notification_channel(input);
171 self
172 }
173 /// <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>
174 pub fn set_notification_channel(mut self, input: ::std::option::Option<crate::types::NotificationChannel>) -> Self {
175 self.inner = self.inner.set_notification_channel(input);
176 self
177 }
178 /// <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>
179 pub fn get_notification_channel(&self) -> &::std::option::Option<crate::types::NotificationChannel> {
180 self.inner.get_notification_channel()
181 }
182 /// <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
183 pub fn job_tag(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
184 self.inner = self.inner.job_tag(input.into());
185 self
186 }
187 /// <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
188 pub fn set_job_tag(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
189 self.inner = self.inner.set_job_tag(input);
190 self
191 }
192 /// <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
193 pub fn get_job_tag(&self) -> &::std::option::Option<::std::string::String> {
194 self.inner.get_job_tag()
195 }
196}