aws_sdk_rekognition/operation/get_text_detection/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_text_detection::_get_text_detection_output::GetTextDetectionOutputBuilder;
3
4pub use crate::operation::get_text_detection::_get_text_detection_input::GetTextDetectionInputBuilder;
5
6impl crate::operation::get_text_detection::builders::GetTextDetectionInputBuilder {
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::get_text_detection::GetTextDetectionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_text_detection::GetTextDetectionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_text_detection();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetTextDetection`.
24///
25/// <p>Gets the text detection results of a Amazon Rekognition Video analysis started by <code>StartTextDetection</code>.</p>
26/// <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling <code>StartTextDetection</code> which returns a job identifier (<code>JobId</code>) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartTextDetection</code>. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. if so, call <code>GetTextDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call of <code>StartLabelDetection</code>.</p>
27/// <p><code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by the time the text was detected, up to 100 words per frame of video.</p>
28/// <p>Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.</p>
29/// <p>Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetTextDetection</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetTextDetection</code>.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct GetTextDetectionFluentBuilder {
32 handle: ::std::sync::Arc<crate::client::Handle>,
33 inner: crate::operation::get_text_detection::builders::GetTextDetectionInputBuilder,
34 config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37 crate::client::customize::internal::CustomizableSend<
38 crate::operation::get_text_detection::GetTextDetectionOutput,
39 crate::operation::get_text_detection::GetTextDetectionError,
40 > for GetTextDetectionFluentBuilder
41{
42 fn send(
43 self,
44 config_override: crate::config::Builder,
45 ) -> crate::client::customize::internal::BoxFuture<
46 crate::client::customize::internal::SendResult<
47 crate::operation::get_text_detection::GetTextDetectionOutput,
48 crate::operation::get_text_detection::GetTextDetectionError,
49 >,
50 > {
51 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52 }
53}
54impl GetTextDetectionFluentBuilder {
55 /// Creates a new `GetTextDetectionFluentBuilder`.
56 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57 Self {
58 handle,
59 inner: ::std::default::Default::default(),
60 config_override: ::std::option::Option::None,
61 }
62 }
63 /// Access the GetTextDetection as a reference.
64 pub fn as_input(&self) -> &crate::operation::get_text_detection::builders::GetTextDetectionInputBuilder {
65 &self.inner
66 }
67 /// Sends the request and returns the response.
68 ///
69 /// If an error occurs, an `SdkError` will be returned with additional details that
70 /// can be matched against.
71 ///
72 /// By default, any retryable failures will be retried twice. Retry behavior
73 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74 /// set when configuring the client.
75 pub async fn send(
76 self,
77 ) -> ::std::result::Result<
78 crate::operation::get_text_detection::GetTextDetectionOutput,
79 ::aws_smithy_runtime_api::client::result::SdkError<
80 crate::operation::get_text_detection::GetTextDetectionError,
81 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82 >,
83 > {
84 let input = self
85 .inner
86 .build()
87 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88 let runtime_plugins = crate::operation::get_text_detection::GetTextDetection::operation_runtime_plugins(
89 self.handle.runtime_plugins.clone(),
90 &self.handle.conf,
91 self.config_override,
92 );
93 crate::operation::get_text_detection::GetTextDetection::orchestrate(&runtime_plugins, input).await
94 }
95
96 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97 pub fn customize(
98 self,
99 ) -> crate::client::customize::CustomizableOperation<
100 crate::operation::get_text_detection::GetTextDetectionOutput,
101 crate::operation::get_text_detection::GetTextDetectionError,
102 Self,
103 > {
104 crate::client::customize::CustomizableOperation::new(self)
105 }
106 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107 self.set_config_override(::std::option::Option::Some(config_override.into()));
108 self
109 }
110
111 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112 self.config_override = config_override;
113 self
114 }
115 /// Create a paginator for this request
116 ///
117 /// Paginators are used by calling [`send().await`](crate::operation::get_text_detection::paginator::GetTextDetectionPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
118 pub fn into_paginator(self) -> crate::operation::get_text_detection::paginator::GetTextDetectionPaginator {
119 crate::operation::get_text_detection::paginator::GetTextDetectionPaginator::new(self.handle, self.inner)
120 }
121 /// <p>Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to <code>StartTextDetection</code>.</p>
122 pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123 self.inner = self.inner.job_id(input.into());
124 self
125 }
126 /// <p>Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to <code>StartTextDetection</code>.</p>
127 pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128 self.inner = self.inner.set_job_id(input);
129 self
130 }
131 /// <p>Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to <code>StartTextDetection</code>.</p>
132 pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
133 self.inner.get_job_id()
134 }
135 /// <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>
136 pub fn max_results(mut self, input: i32) -> Self {
137 self.inner = self.inner.max_results(input);
138 self
139 }
140 /// <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>
141 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
142 self.inner = self.inner.set_max_results(input);
143 self
144 }
145 /// <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>
146 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
147 self.inner.get_max_results()
148 }
149 /// <p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>
150 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
151 self.inner = self.inner.next_token(input.into());
152 self
153 }
154 /// <p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>
155 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
156 self.inner = self.inner.set_next_token(input);
157 self
158 }
159 /// <p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>
160 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
161 self.inner.get_next_token()
162 }
163}