aws_sdk_polly/operation/describe_voices/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_voices::_describe_voices_output::DescribeVoicesOutputBuilder;
3
4pub use crate::operation::describe_voices::_describe_voices_input::DescribeVoicesInputBuilder;
5
6impl crate::operation::describe_voices::builders::DescribeVoicesInputBuilder {
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::describe_voices::DescribeVoicesOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_voices::DescribeVoicesError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_voices();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeVoices`.
24///
25/// <p>Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.</p>
26/// <p>When synthesizing speech ( <code>SynthesizeSpeech</code> ), you provide the voice ID for the voice you want from the list of voices returned by <code>DescribeVoices</code>.</p>
27/// <p>For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the <code>DescribeVoices</code> operation you can provide the user with a list of available voices to select from.</p>
28/// <p>You can optionally specify a language code to filter the available voices. For example, if you specify <code>en-US</code>, the operation returns a list of all available US English voices.</p>
29/// <p>This operation requires permissions to perform the <code>polly:DescribeVoices</code> action.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct DescribeVoicesFluentBuilder {
32 handle: ::std::sync::Arc<crate::client::Handle>,
33 inner: crate::operation::describe_voices::builders::DescribeVoicesInputBuilder,
34 config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37 crate::client::customize::internal::CustomizableSend<
38 crate::operation::describe_voices::DescribeVoicesOutput,
39 crate::operation::describe_voices::DescribeVoicesError,
40 > for DescribeVoicesFluentBuilder
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::describe_voices::DescribeVoicesOutput,
48 crate::operation::describe_voices::DescribeVoicesError,
49 >,
50 > {
51 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52 }
53}
54impl DescribeVoicesFluentBuilder {
55 /// Creates a new `DescribeVoicesFluentBuilder`.
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 DescribeVoices as a reference.
64 pub fn as_input(&self) -> &crate::operation::describe_voices::builders::DescribeVoicesInputBuilder {
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::describe_voices::DescribeVoicesOutput,
79 ::aws_smithy_runtime_api::client::result::SdkError<
80 crate::operation::describe_voices::DescribeVoicesError,
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::describe_voices::DescribeVoices::operation_runtime_plugins(
89 self.handle.runtime_plugins.clone(),
90 &self.handle.conf,
91 self.config_override,
92 );
93 crate::operation::describe_voices::DescribeVoices::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::describe_voices::DescribeVoicesOutput,
101 crate::operation::describe_voices::DescribeVoicesError,
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 /// <p>Specifies the engine (<code>standard</code>, <code>neural</code>, <code>long-form</code> or <code>generative</code>) used by Amazon Polly when processing input text for speech synthesis.</p>
116 pub fn engine(mut self, input: crate::types::Engine) -> Self {
117 self.inner = self.inner.engine(input);
118 self
119 }
120 /// <p>Specifies the engine (<code>standard</code>, <code>neural</code>, <code>long-form</code> or <code>generative</code>) used by Amazon Polly when processing input text for speech synthesis.</p>
121 pub fn set_engine(mut self, input: ::std::option::Option<crate::types::Engine>) -> Self {
122 self.inner = self.inner.set_engine(input);
123 self
124 }
125 /// <p>Specifies the engine (<code>standard</code>, <code>neural</code>, <code>long-form</code> or <code>generative</code>) used by Amazon Polly when processing input text for speech synthesis.</p>
126 pub fn get_engine(&self) -> &::std::option::Option<crate::types::Engine> {
127 self.inner.get_engine()
128 }
129 /// <p>The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.</p>
130 pub fn language_code(mut self, input: crate::types::LanguageCode) -> Self {
131 self.inner = self.inner.language_code(input);
132 self
133 }
134 /// <p>The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.</p>
135 pub fn set_language_code(mut self, input: ::std::option::Option<crate::types::LanguageCode>) -> Self {
136 self.inner = self.inner.set_language_code(input);
137 self
138 }
139 /// <p>The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.</p>
140 pub fn get_language_code(&self) -> &::std::option::Option<crate::types::LanguageCode> {
141 self.inner.get_language_code()
142 }
143 /// <p>Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify <code>yes</code> but not if you specify <code>no</code>.</p>
144 pub fn include_additional_language_codes(mut self, input: bool) -> Self {
145 self.inner = self.inner.include_additional_language_codes(input);
146 self
147 }
148 /// <p>Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify <code>yes</code> but not if you specify <code>no</code>.</p>
149 pub fn set_include_additional_language_codes(mut self, input: ::std::option::Option<bool>) -> Self {
150 self.inner = self.inner.set_include_additional_language_codes(input);
151 self
152 }
153 /// <p>Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify <code>yes</code> but not if you specify <code>no</code>.</p>
154 pub fn get_include_additional_language_codes(&self) -> &::std::option::Option<bool> {
155 self.inner.get_include_additional_language_codes()
156 }
157 /// <p>An opaque pagination token returned from the previous <code>DescribeVoices</code> operation. If present, this indicates where to continue the listing.</p>
158 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159 self.inner = self.inner.next_token(input.into());
160 self
161 }
162 /// <p>An opaque pagination token returned from the previous <code>DescribeVoices</code> operation. If present, this indicates where to continue the listing.</p>
163 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
164 self.inner = self.inner.set_next_token(input);
165 self
166 }
167 /// <p>An opaque pagination token returned from the previous <code>DescribeVoices</code> operation. If present, this indicates where to continue the listing.</p>
168 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
169 self.inner.get_next_token()
170 }
171}